Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Mysql
  5. getReplica
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.Mysql.getReplica

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific Replica resource in Oracle Cloud Infrastructure MySQL Database service.

Gets the full details of the specified read replica.

Example Usage

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

const testReplica = oci.Mysql.getReplica({
    replicaId: testReplicaOciMysqlReplica.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_replica = oci.Mysql.get_replica(replica_id=test_replica_oci_mysql_replica["id"])
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.GetReplica(ctx, &mysql.GetReplicaArgs{
			ReplicaId: testReplicaOciMysqlReplica.Id,
		}, 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 testReplica = Oci.Mysql.GetReplica.Invoke(new()
    {
        ReplicaId = testReplicaOciMysqlReplica.Id,
    });

});
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.GetReplicaArgs;
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 testReplica = MysqlFunctions.getReplica(GetReplicaArgs.builder()
            .replicaId(testReplicaOciMysqlReplica.id())
            .build());

    }
}
Copy
variables:
  testReplica:
    fn::invoke:
      function: oci:Mysql:getReplica
      arguments:
        replicaId: ${testReplicaOciMysqlReplica.id}
Copy

Using getReplica

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 getReplica(args: GetReplicaArgs, opts?: InvokeOptions): Promise<GetReplicaResult>
function getReplicaOutput(args: GetReplicaOutputArgs, opts?: InvokeOptions): Output<GetReplicaResult>
Copy
def get_replica(replica_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetReplicaResult
def get_replica_output(replica_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetReplicaResult]
Copy
func GetReplica(ctx *Context, args *GetReplicaArgs, opts ...InvokeOption) (*GetReplicaResult, error)
func GetReplicaOutput(ctx *Context, args *GetReplicaOutputArgs, opts ...InvokeOption) GetReplicaResultOutput
Copy

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

public static class GetReplica 
{
    public static Task<GetReplicaResult> InvokeAsync(GetReplicaArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicaResult> Invoke(GetReplicaInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetReplicaResult> getReplica(GetReplicaArgs args, InvokeOptions options)
public static Output<GetReplicaResult> getReplica(GetReplicaArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Mysql/getReplica:getReplica
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ReplicaId This property is required. string
The Replica OCID.
ReplicaId This property is required. string
The Replica OCID.
replicaId This property is required. String
The Replica OCID.
replicaId This property is required. string
The Replica OCID.
replica_id This property is required. str
The Replica OCID.
replicaId This property is required. String
The Replica OCID.

getReplica Result

The following output properties are available:

AvailabilityDomain string
The name of the Availability Domain the read replica is located in.
CompartmentId string
The OCID of the compartment that contains the read replica.
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.
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
User provided description of the read replica.
DisplayName string
The user-friendly name for the read replica. It does not have to be unique.
FaultDomain string
The name of the Fault Domain the read replica is located in.
FreeformTags 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 string
The OCID of the read replica.
IpAddress string
The IP address the read replica is configured to listen on.
IsDeleteProtected 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 string
A message describing the state of the read replica.
MysqlVersion string
The MySQL version to be used by the read replica.
Port int
The port the read replica is configured to listen on.
PortX int
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
ReplicaId string
ReplicaOverrides List<GetReplicaReplicaOverride>
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 List<GetReplicaSecureConnection>
Secure connection configuration details.
ShapeName 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 string
The state of the read replica.
TimeCreated string
The date and time the read replica was created, as described by RFC 3339.
TimeUpdated string
The time the read replica was last updated, as described by RFC 3339.
AvailabilityDomain string
The name of the Availability Domain the read replica is located in.
CompartmentId string
The OCID of the compartment that contains the read replica.
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.
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string
User provided description of the read replica.
DisplayName string
The user-friendly name for the read replica. It does not have to be unique.
FaultDomain string
The name of the Fault Domain the read replica is located in.
FreeformTags 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 string
The OCID of the read replica.
IpAddress string
The IP address the read replica is configured to listen on.
IsDeleteProtected 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 string
A message describing the state of the read replica.
MysqlVersion string
The MySQL version to be used by the read replica.
Port int
The port the read replica is configured to listen on.
PortX int
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
ReplicaId string
ReplicaOverrides []GetReplicaReplicaOverride
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 []GetReplicaSecureConnection
Secure connection configuration details.
ShapeName 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 string
The state of the read replica.
TimeCreated string
The date and time the read replica was created, as described by RFC 3339.
TimeUpdated string
The time the read replica was last updated, as described by RFC 3339.
availabilityDomain String
The name of the Availability Domain the read replica is located in.
compartmentId String
The OCID of the compartment that contains the read replica.
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.
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
User provided description of the read replica.
displayName String
The user-friendly name for the read replica. It does not have to be unique.
faultDomain String
The name of the Fault Domain the read replica is located in.
freeformTags 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 String
The OCID of the read replica.
ipAddress String
The IP address the read replica is configured to listen on.
isDeleteProtected 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 String
A message describing the state of the read replica.
mysqlVersion String
The MySQL version to be used by the read replica.
port Integer
The port the read replica is configured to listen on.
portX Integer
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
replicaId String
replicaOverrides List<GetReplicaReplicaOverride>
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 List<GetReplicaSecureConnection>
Secure connection configuration details.
shapeName 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 String
The state of the read replica.
timeCreated String
The date and time the read replica was created, as described by RFC 3339.
timeUpdated String
The time the read replica was last updated, as described by RFC 3339.
availabilityDomain string
The name of the Availability Domain the read replica is located in.
compartmentId string
The OCID of the compartment that contains the read replica.
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.
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string
User provided description of the read replica.
displayName string
The user-friendly name for the read replica. It does not have to be unique.
faultDomain string
The name of the Fault Domain the read replica is located in.
freeformTags {[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 string
The OCID of the read replica.
ipAddress string
The IP address the read replica is configured to listen on.
isDeleteProtected 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 string
A message describing the state of the read replica.
mysqlVersion string
The MySQL version to be used by the read replica.
port number
The port the read replica is configured to listen on.
portX number
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
replicaId string
replicaOverrides GetReplicaReplicaOverride[]
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 GetReplicaSecureConnection[]
Secure connection configuration details.
shapeName 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 string
The state of the read replica.
timeCreated string
The date and time the read replica was created, as described by RFC 3339.
timeUpdated string
The time the read replica was last updated, as described by RFC 3339.
availability_domain str
The name of the Availability Domain the read replica is located in.
compartment_id str
The OCID of the compartment that contains the read replica.
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.
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str
User provided description of the read replica.
display_name str
The user-friendly name for the read replica. It does not have to be unique.
fault_domain str
The name of the Fault Domain the read replica is located in.
freeform_tags 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 str
The OCID of the read replica.
ip_address str
The IP address the read replica is configured to listen on.
is_delete_protected 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 str
A message describing the state of the read replica.
mysql_version str
The MySQL version to be used by the read replica.
port int
The port the read replica is configured to listen on.
port_x int
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
replica_id str
replica_overrides Sequence[mysql.GetReplicaReplicaOverride]
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 Sequence[mysql.GetReplicaSecureConnection]
Secure connection configuration details.
shape_name 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 str
The state of the read replica.
time_created str
The date and time the read replica was created, as described by RFC 3339.
time_updated str
The time the read replica was last updated, as described by RFC 3339.
availabilityDomain String
The name of the Availability Domain the read replica is located in.
compartmentId String
The OCID of the compartment that contains the read replica.
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.
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
User provided description of the read replica.
displayName String
The user-friendly name for the read replica. It does not have to be unique.
faultDomain String
The name of the Fault Domain the read replica is located in.
freeformTags 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 String
The OCID of the read replica.
ipAddress String
The IP address the read replica is configured to listen on.
isDeleteProtected 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 String
A message describing the state of the read replica.
mysqlVersion String
The MySQL version to be used by the read replica.
port Number
The port the read replica is configured to listen on.
portX Number
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
replicaId String
replicaOverrides 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 List<Property Map>
Secure connection configuration details.
shapeName 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 String
The state of the read replica.
timeCreated String
The date and time the read replica was created, as described by RFC 3339.
timeUpdated String
The time the read replica was last updated, as described by RFC 3339.

Supporting Types

GetReplicaReplicaOverride

ConfigurationId This property is required. string
The OCID of the Configuration to be used by the read replica.
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 OCID of the Configuration to be used by the read replica.
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 OCID of the Configuration to be used by the read replica.
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 OCID of the Configuration to be used by the read replica.
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 OCID of the Configuration to be used by the read replica.
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 OCID of the Configuration to be used by the read replica.
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.

GetReplicaSecureConnection

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.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci