Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

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 System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testChannel = Oci.Mysql.GetChannel.Invoke(new()
    {
        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
	})
}

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(oci_mysql_channel.test_channel().id())
            .build());

    }
}

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,
});

variables:
  testChannel:
    Fn::Invoke:
      Function: oci:Mysql:getChannel
      Arguments:
        channelId: ${oci_mysql_channel.test_channel.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:

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, 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.
DisplayName string: The user-friendly name for the Channel. It does not have to be unique.
FreeformTags 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
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.
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]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.
DisplayName string: The user-friendly name for the Channel. It does not have to be unique.
FreeformTags 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
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.
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,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.
displayName String: The user-friendly name for the Channel. It does not have to be unique.
freeformTags 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
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.
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]: 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.
displayName string: The user-friendly name for the Channel. It does not have to be unique.
freeformTags {[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
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.
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, 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.
freeform_tags 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 GetChannelSource]: Parameters detailing how to provision the source for the given Channel.
state str: The state of the Channel.
targets 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<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.
displayName String: The user-friendly name for the Channel. It does not have to be unique.
freeformTags 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
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.
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

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

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

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

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

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 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

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

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.
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.
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.
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.
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.
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.
targetType 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.