Oracle Cloud Infrastructure
getChannel
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
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testChannel = Output.Create(Oci.Mysql.GetChannel.InvokeAsync(new Oci.Mysql.GetChannelArgs
{
ChannelId = oci_mysql_channel.Test_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: oci_mysql_channel.Test_channel.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_channel = oci.Mysql.get_channel(channel_id=oci_mysql_channel["test_channel"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testChannel = oci.Mysql.getChannel({
channelId: oci_mysql_channel.test_channel.id,
});
Coming soon!
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
Get
Channel Source] Parameters detailing how to provision the source for the given Channel.
- state str
The state of the Channel.
- targets
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
- 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
- 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
- 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
- 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
- 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_ Getcertificates 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
- 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
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.
- 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.
- 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.
- 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.
- 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.
- 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.
- target
Type String The specific target identifier.
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.