Oracle Cloud Infrastructure v2.30.0, Apr 14 25

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.Mysql.getChannel

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testChannel = oci.Mysql.getChannel({
    channelId: testChannelOciMysqlChannel.id,
});

import pulumi
import pulumi_oci as oci

test_channel = oci.Mysql.get_channel(channel_id=test_channel_oci_mysql_channel["id"])

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.GetChannel(ctx, &mysql.GetChannelArgs{
			ChannelId: testChannelOciMysqlChannel.Id,
		}, nil)
		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 testChannel = Oci.Mysql.GetChannel.Invoke(new()
    {
        ChannelId = testChannelOciMysqlChannel.Id,
    });

});

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.GetChannelArgs;
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 testChannel = MysqlFunctions.getChannel(GetChannelArgs.builder()
            .channelId(testChannelOciMysqlChannel.id())
            .build());

    }
}

variables:
  testChannel:
    fn::invoke:
      function: oci:Mysql:getChannel
      arguments:
        channelId: ${testChannelOciMysqlChannel.id}

Using getChannel

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.

TypeScript
Python
Go
C#
Java
YAML

function getChannel(args: GetChannelArgs, opts?: InvokeOptions): Promise<GetChannelResult>
function getChannelOutput(args: GetChannelOutputArgs, opts?: InvokeOptions): Output<GetChannelResult>

def get_channel(channel_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetChannelResult
def get_channel_output(channel_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetChannelResult]

func GetChannel(ctx *Context, args *GetChannelArgs, opts ...InvokeOption) (*GetChannelResult, error)
func GetChannelOutput(ctx *Context, args *GetChannelOutputArgs, opts ...InvokeOption) GetChannelResultOutput

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

public static class GetChannel 
{
    public static Task<GetChannelResult> InvokeAsync(GetChannelArgs args, InvokeOptions? opts = null)
    public static Output<GetChannelResult> Invoke(GetChannelInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)
public static Output<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Mysql/getChannel:getChannel
  arguments:
    # arguments dictionary

The following arguments are supported:

ChannelId string: The Channel OCID.

ChannelId string: The Channel OCID.

channelId String: The Channel OCID.

channelId string: The Channel OCID.

channel_id str: The Channel OCID.

channelId String: The Channel OCID.

getChannel Result

The following output properties are available:

ChannelId string
CompartmentId string: The OCID of the compartment.
DefinedTags Dictionary<string, string>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string: User provided description of the Channel.
DisplayName string: The user-friendly name for the Channel. It does not have to be unique.
FreeformTags Dictionary<string, string>: Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string
IsEnabled bool: Whether the Channel has been enabled by the user.
LifecycleDetails string: A message describing the state of the Channel.
Sources List<GetChannelSource>: Parameters detailing how to provision the source for the given Channel.
State string: The state of the Channel.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
Targets List<GetChannelTarget>: Details about the Channel target.
TimeCreated string: The date and time the Channel was created, as described by RFC 3339.
TimeUpdated string: The time the Channel was last updated, as described by RFC 3339.

ChannelId string
CompartmentId string: The OCID of the compartment.
DefinedTags map[string]string: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
Description string: User provided description of the Channel.
DisplayName string: The user-friendly name for the Channel. It does not have to be unique.
FreeformTags map[string]string: Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string
IsEnabled bool: Whether the Channel has been enabled by the user.
LifecycleDetails string: A message describing the state of the Channel.
Sources []GetChannelSource: Parameters detailing how to provision the source for the given Channel.
State string: The state of the Channel.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
Targets []GetChannelTarget: Details about the Channel target.
TimeCreated string: The date and time the Channel was created, as described by RFC 3339.
TimeUpdated string: The time the Channel was last updated, as described by RFC 3339.

channelId String
compartmentId String: The OCID of the compartment.
definedTags Map<String,String>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String: User provided description of the Channel.
displayName String: The user-friendly name for the Channel. It does not have to be unique.
freeformTags Map<String,String>: Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String
isEnabled Boolean: Whether the Channel has been enabled by the user.
lifecycleDetails String: A message describing the state of the Channel.
sources List<GetChannelSource>: Parameters detailing how to provision the source for the given Channel.
state String: The state of the Channel.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
targets List<GetChannelTarget>: Details about the Channel target.
timeCreated String: The date and time the Channel was created, as described by RFC 3339.
timeUpdated String: The time the Channel was last updated, as described by RFC 3339.

channelId string
compartmentId string: The OCID of the compartment.
definedTags {[key: string]: string}: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description string: User provided description of the Channel.
displayName string: The user-friendly name for the Channel. It does not have to be unique.
freeformTags {[key: string]: string}: Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string
isEnabled boolean: Whether the Channel has been enabled by the user.
lifecycleDetails string: A message describing the state of the Channel.
sources GetChannelSource[]: Parameters detailing how to provision the source for the given Channel.
state string: The state of the Channel.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
targets GetChannelTarget[]: Details about the Channel target.
timeCreated string: The date and time the Channel was created, as described by RFC 3339.
timeUpdated string: The time the Channel was last updated, as described by RFC 3339.

channel_id str
compartment_id str: The OCID of the compartment.
defined_tags Mapping[str, str]: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description str: User provided description of the Channel.
display_name str: The user-friendly name for the Channel. It does not have to be unique.
freeform_tags Mapping[str, str]: Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str
is_enabled bool: Whether the Channel has been enabled by the user.
lifecycle_details str: A message describing the state of the Channel.
sources Sequence[mysql.GetChannelSource]: Parameters detailing how to provision the source for the given Channel.
state str: The state of the Channel.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
targets Sequence[mysql.GetChannelTarget]: Details about the Channel target.
time_created str: The date and time the Channel was created, as described by RFC 3339.
time_updated str: The time the Channel was last updated, as described by RFC 3339.

channelId String
compartmentId String: The OCID of the compartment.
definedTags Map<String>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
description String: User provided description of the Channel.
displayName String: The user-friendly name for the Channel. It does not have to be unique.
freeformTags Map<String>: Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String
isEnabled Boolean: Whether the Channel has been enabled by the user.
lifecycleDetails String: A message describing the state of the Channel.
sources List<Property Map>: Parameters detailing how to provision the source for the given Channel.
state String: The state of the Channel.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
targets List<Property Map>: Details about the Channel target.
timeCreated String: The date and time the Channel was created, as described by RFC 3339.
timeUpdated String: The time the Channel was last updated, as described by RFC 3339.

Supporting Types

GetChannelSource

AnonymousTransactionsHandlings List<GetChannelSourceAnonymousTransactionsHandling>: Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does.
Hostname string: The network address of the MySQL instance.
Password string
Port int: The port the source MySQL instance listens on.
SourceType string: The specific source identifier.
SslCaCertificates List<GetChannelSourceSslCaCertificate>: The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
SslMode string: The SSL mode of the Channel.
Username string: The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

AnonymousTransactionsHandlings []GetChannelSourceAnonymousTransactionsHandling: Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does.
Hostname string: The network address of the MySQL instance.
Password string
Port int: The port the source MySQL instance listens on.
SourceType string: The specific source identifier.
SslCaCertificates []GetChannelSourceSslCaCertificate: The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
SslMode string: The SSL mode of the Channel.
Username string: The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

anonymousTransactionsHandlings List<GetChannelSourceAnonymousTransactionsHandling>: Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does.
hostname String: The network address of the MySQL instance.
password String
port Integer: The port the source MySQL instance listens on.
sourceType String: The specific source identifier.
sslCaCertificates List<GetChannelSourceSslCaCertificate>: The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
sslMode String: The SSL mode of the Channel.
username String: The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

anonymousTransactionsHandlings GetChannelSourceAnonymousTransactionsHandling[]: Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does.
hostname string: The network address of the MySQL instance.
password string
port number: The port the source MySQL instance listens on.
sourceType string: The specific source identifier.
sslCaCertificates GetChannelSourceSslCaCertificate[]: The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
sslMode string: The SSL mode of the Channel.
username string: The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

anonymous_transactions_handlings Sequence[mysql.GetChannelSourceAnonymousTransactionsHandling]: Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does.
hostname str: The network address of the MySQL instance.
password str
port int: The port the source MySQL instance listens on.
source_type str: The specific source identifier.
ssl_ca_certificates Sequence[mysql.GetChannelSourceSslCaCertificate]: The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
ssl_mode str: The SSL mode of the Channel.
username str: The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

anonymousTransactionsHandlings List<Property Map>: Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does.
hostname String: The network address of the MySQL instance.
password String
port Number: The port the source MySQL instance listens on.
sourceType String: The specific source identifier.
sslCaCertificates List<Property Map>: The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
sslMode String: The SSL mode of the Channel.
username String: The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation

GetChannelSourceAnonymousTransactionsHandling

LastConfiguredLogFilename string: Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
LastConfiguredLogOffset string: Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
Policy string: Specifies how the replication channel handles anonymous transactions.
Uuid string: The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later.

LastConfiguredLogFilename string: Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
LastConfiguredLogOffset string: Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
Policy string: Specifies how the replication channel handles anonymous transactions.
Uuid string: The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later.

lastConfiguredLogFilename String: Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
lastConfiguredLogOffset String: Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
policy String: Specifies how the replication channel handles anonymous transactions.
uuid String: The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later.

lastConfiguredLogFilename string: Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
lastConfiguredLogOffset string: Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
policy string: Specifies how the replication channel handles anonymous transactions.
uuid string: The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later.

last_configured_log_filename str: Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
last_configured_log_offset str: Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
policy str: Specifies how the replication channel handles anonymous transactions.
uuid str: The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later.

lastConfiguredLogFilename String: Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
lastConfiguredLogOffset String: Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
policy String: Specifies how the replication channel handles anonymous transactions.
uuid String: The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later.

GetChannelSourceSslCaCertificate

CertificateType string: The type of CA certificate.
Contents string: The string containing the CA certificate in PEM format.

CertificateType string: The type of CA certificate.
Contents string: The string containing the CA certificate in PEM format.

certificateType String: The type of CA certificate.
contents String: The string containing the CA certificate in PEM format.

certificateType string: The type of CA certificate.
contents string: The string containing the CA certificate in PEM format.

certificate_type str: The type of CA certificate.
contents str: The string containing the CA certificate in PEM format.

certificateType String: The type of CA certificate.
contents String: The string containing the CA certificate in PEM format.

GetChannelTarget

ApplierUsername string: The username for the replication applier of the target MySQL DB System.
ChannelName string: The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.
DbSystemId string: The OCID of the source DB System.
DelayInSeconds int: Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
Filters List<GetChannelTargetFilter>: Replication filter rules to be applied at the DB System Channel target.
TablesWithoutPrimaryKeyHandling string: Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
TargetType string: The specific target identifier.

ApplierUsername string: The username for the replication applier of the target MySQL DB System.
ChannelName string: The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.
DbSystemId string: The OCID of the source DB System.
DelayInSeconds int: Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
Filters []GetChannelTargetFilter: Replication filter rules to be applied at the DB System Channel target.
TablesWithoutPrimaryKeyHandling string: Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
TargetType string: The specific target identifier.

applierUsername String: The username for the replication applier of the target MySQL DB System.
channelName String: The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.
dbSystemId String: The OCID of the source DB System.
delayInSeconds Integer: Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
filters List<GetChannelTargetFilter>: Replication filter rules to be applied at the DB System Channel target.
tablesWithoutPrimaryKeyHandling String: Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
targetType String: The specific target identifier.

applierUsername string: The username for the replication applier of the target MySQL DB System.
channelName string: The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.
dbSystemId string: The OCID of the source DB System.
delayInSeconds number: Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
filters GetChannelTargetFilter[]: Replication filter rules to be applied at the DB System Channel target.
tablesWithoutPrimaryKeyHandling string: Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
targetType string: The specific target identifier.

applier_username str: The username for the replication applier of the target MySQL DB System.
channel_name str: The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.
db_system_id str: The OCID of the source DB System.
delay_in_seconds int: Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
filters Sequence[mysql.GetChannelTargetFilter]: Replication filter rules to be applied at the DB System Channel target.
tables_without_primary_key_handling str: Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
target_type str: The specific target identifier.

applierUsername String: The username for the replication applier of the target MySQL DB System.
channelName String: The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.
dbSystemId String: The OCID of the source DB System.
delayInSeconds Number: Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
filters List<Property Map>: Replication filter rules to be applied at the DB System Channel target.
tablesWithoutPrimaryKeyHandling String: Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
targetType String: The specific target identifier.

GetChannelTargetFilter

Type string: The type of the filter rule.
Value string: The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see Replication Filtering Rules.

Type string: The type of the filter rule.
Value string: The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see Replication Filtering Rules.

type String: The type of the filter rule.
value String: The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see Replication Filtering Rules.

type string: The type of the filter rule.
value string: The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see Replication Filtering Rules.

type str: The type of the filter rule.
value str: The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see Replication Filtering Rules.

type String: The type of the filter rule.
value String: The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see Replication Filtering Rules.

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.30.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-oci

oci.Mysql.getChannel

On this page

On this page

Example Usage

Using getChannel

getChannel Result

Supporting Types

GetChannelSource

GetChannelSourceAnonymousTransactionsHandling

GetChannelSourceSslCaCertificate

GetChannelTarget

GetChannelTargetFilter

Package Details

On this page

On this page