Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
oci.Mysql.getChannel
Explore with Pulumi AI
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
This data source provides details about a specific Channel resource in Oracle Cloud Infrastructure MySQL Database service.
Gets the full details of the specified Channel, including the user-specified configuration parameters (passwords are omitted), as well as information about the state of the Channel, its sources and targets.
Example Usage
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/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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Mysql/getChannel:getChannel
arguments:
# arguments dictionary
The following arguments are supported:
- channel_
id str - The Channel OCID.
getChannel Result
The following output properties are available:
- Channel
Id string - Compartment
Id string - The OCID of the compartment.
- Dictionary<string, object>
- 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.
- Display
Name string - The user-friendly name for the Channel. It does not have to be unique.
- Dictionary<string, object>
- Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Id string
- Is
Enabled bool - Whether the Channel has been enabled by the user.
- Lifecycle
Details string - A message describing the state of the Channel.
- Sources
List<Get
Channel Source> - Parameters detailing how to provision the source for the given Channel.
- State string
- The state of the Channel.
- Targets
List<Get
Channel Target> - Details about the Channel target.
- Time
Created string - The date and time the Channel was created, as described by RFC 3339.
- Time
Updated string - The time the Channel was last updated, as described by RFC 3339.
- Channel
Id string - Compartment
Id string - The OCID of the compartment.
- map[string]interface{}
- 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.
- Display
Name string - The user-friendly name for the Channel. It does not have to be unique.
- map[string]interface{}
- Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Id string
- Is
Enabled bool - Whether the Channel has been enabled by the user.
- Lifecycle
Details string - A message describing the state of the Channel.
- Sources
[]Get
Channel Source - Parameters detailing how to provision the source for the given Channel.
- State string
- The state of the Channel.
- Targets
[]Get
Channel Target - Details about the Channel target.
- Time
Created string - The date and time the Channel was created, as described by RFC 3339.
- Time
Updated string - The time the Channel was last updated, as described by RFC 3339.
- channel
Id String - compartment
Id String - The OCID of the compartment.
- Map<String,Object>
- 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.
- display
Name String - The user-friendly name for the Channel. It does not have to be unique.
- Map<String,Object>
- Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- id String
- is
Enabled Boolean - Whether the Channel has been enabled by the user.
- lifecycle
Details String - A message describing the state of the Channel.
- sources
List<Get
Channel Source> - Parameters detailing how to provision the source for the given Channel.
- state String
- The state of the Channel.
- targets
List<Get
Channel Target> - Details about the Channel target.
- time
Created String - The date and time the Channel was created, as described by RFC 3339.
- time
Updated String - The time the Channel was last updated, as described by RFC 3339.
- channel
Id string - compartment
Id string - The OCID of the compartment.
- {[key: string]: any}
- 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.
- display
Name string - The user-friendly name for the Channel. It does not have to be unique.
- {[key: string]: any}
- Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- id string
- is
Enabled boolean - Whether the Channel has been enabled by the user.
- lifecycle
Details string - A message describing the state of the Channel.
- sources
Get
Channel Source[] - Parameters detailing how to provision the source for the given Channel.
- state string
- The state of the Channel.
- targets
Get
Channel Target[] - Details about the Channel target.
- time
Created string - The date and time the Channel was created, as described by RFC 3339.
- time
Updated string - The time the Channel was last updated, as described by RFC 3339.
- channel_
id str - compartment_
id str - The OCID of the compartment.
- Mapping[str, Any]
- 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.
- Mapping[str, Any]
- 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.
Get Channel Source] - Parameters detailing how to provision the source for the given Channel.
- state str
- The state of the Channel.
- targets
Sequence[mysql.
Get Channel Target] - 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.
- channel
Id String - compartment
Id String - The OCID of the compartment.
- Map<Any>
- 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.
- display
Name String - The user-friendly name for the Channel. It does not have to be unique.
- Map<Any>
- Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- id String
- is
Enabled Boolean - Whether the Channel has been enabled by the user.
- lifecycle
Details 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.
- targets List<Property Map>
- Details about the Channel target.
- time
Created String - The date and time the Channel was created, as described by RFC 3339.
- time
Updated String - The time the Channel was last updated, as described by RFC 3339.
Supporting Types
GetChannelSource
- Anonymous
Transactions List<GetHandlings Channel Source Anonymous Transactions Handling> - 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.
- Source
Type string - The specific source identifier.
- Ssl
Ca List<GetCertificates Channel Source Ssl Ca Certificate> - The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
- Ssl
Mode 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 []GetHandlings Channel Source Anonymous Transactions Handling - 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.
- Source
Type string - The specific source identifier.
- Ssl
Ca []GetCertificates Channel Source Ssl Ca Certificate - The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
- Ssl
Mode 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 List<GetHandlings Channel Source Anonymous Transactions Handling> - 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.
- source
Type String - The specific source identifier.
- ssl
Ca List<GetCertificates Channel Source Ssl Ca Certificate> - The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
- ssl
Mode 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 GetHandlings Channel Source Anonymous Transactions Handling[] - 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.
- source
Type string - The specific source identifier.
- ssl
Ca GetCertificates Channel Source Ssl Ca Certificate[] - The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
- ssl
Mode 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_ Sequence[mysql.handlings Get Channel Source Anonymous Transactions Handling] - 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_ Sequence[mysql.certificates Get Channel Source Ssl Ca Certificate] - 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
- anonymous
Transactions List<Property Map>Handlings - 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.
- source
Type String - The specific source identifier.
- ssl
Ca List<Property Map>Certificates - The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
- ssl
Mode 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
- Last
Configured stringLog Filename - 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 stringLog Offset - 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 stringLog Filename - 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 stringLog Offset - 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 StringLog Filename - 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 StringLog Offset - 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 stringLog Filename - 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 stringLog Offset - 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_ strlog_ filename - 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_ strlog_ offset - 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.
- last
Configured StringLog Filename - 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 StringLog Offset - 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
- Certificate
Type string - The type of CA certificate.
- Contents string
- The string containing the CA certificate in PEM format.
- Certificate
Type string - The type of CA certificate.
- Contents string
- The string containing the CA certificate in PEM format.
- certificate
Type String - The type of CA certificate.
- contents String
- The string containing the CA certificate in PEM format.
- certificate
Type 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.
- certificate
Type String - The type of CA certificate.
- contents String
- The string containing the CA certificate in PEM format.
GetChannelTarget
- Applier
Username string - The username for the replication applier of the target MySQL DB System.
- Channel
Name 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.
- Db
System stringId - The OCID of the source DB System.
- Delay
In intSeconds - Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
- Filters
List<Get
Channel Target Filter> - Replication filter rules to be applied at the DB System Channel target.
- Tables
Without stringPrimary Key Handling - Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
- Target
Type string - The specific target identifier.
- Applier
Username string - The username for the replication applier of the target MySQL DB System.
- Channel
Name 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.
- Db
System stringId - The OCID of the source DB System.
- Delay
In intSeconds - Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
- Filters
[]Get
Channel Target Filter - Replication filter rules to be applied at the DB System Channel target.
- Tables
Without stringPrimary Key Handling - Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
- Target
Type string - The specific target identifier.
- applier
Username String - The username for the replication applier of the target MySQL DB System.
- channel
Name 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.
- db
System StringId - The OCID of the source DB System.
- delay
In IntegerSeconds - Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
- filters
List<Get
Channel Target Filter> - Replication filter rules to be applied at the DB System Channel target.
- tables
Without StringPrimary Key Handling - Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
- target
Type String - The specific target identifier.
- applier
Username string - The username for the replication applier of the target MySQL DB System.
- channel
Name 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.
- db
System stringId - The OCID of the source DB System.
- delay
In numberSeconds - Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
- filters
Get
Channel Target Filter[] - Replication filter rules to be applied at the DB System Channel target.
- tables
Without stringPrimary Key Handling - Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
- target
Type 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_ strid - The OCID of the source DB System.
- delay_
in_ intseconds - Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
- filters
Sequence[mysql.
Get Channel Target Filter] - Replication filter rules to be applied at the DB System Channel target.
- tables_
without_ strprimary_ key_ handling - 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.
- applier
Username String - The username for the replication applier of the target MySQL DB System.
- channel
Name 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.
- db
System StringId - The OCID of the source DB System.
- delay
In NumberSeconds - 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.
- tables
Without StringPrimary Key Handling - Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
- target
Type 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 v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi