Oracle Cloud Infrastructure

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

getChannels

This data source provides the list of Channels in Oracle Cloud Infrastructure MySQL Database service.

Lists all the Channels that match the specified filters.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testChannels = Oci.Mysql.GetChannels.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        ChannelId = oci_mysql_channel.Test_channel.Id,
        DbSystemId = oci_database_db_system.Test_db_system.Id,
        DisplayName = @var.Channel_display_name,
        IsEnabled = @var.Channel_is_enabled,
        State = @var.Channel_state,
    });

});
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.GetChannels(ctx, &mysql.GetChannelsArgs{
			CompartmentId: _var.Compartment_id,
			ChannelId:     pulumi.StringRef(oci_mysql_channel.Test_channel.Id),
			DbSystemId:    pulumi.StringRef(oci_database_db_system.Test_db_system.Id),
			DisplayName:   pulumi.StringRef(_var.Channel_display_name),
			IsEnabled:     pulumi.BoolRef(_var.Channel_is_enabled),
			State:         pulumi.StringRef(_var.Channel_state),
		}, 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.GetChannelsArgs;
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 testChannels = MysqlFunctions.getChannels(GetChannelsArgs.builder()
            .compartmentId(var_.compartment_id())
            .channelId(oci_mysql_channel.test_channel().id())
            .dbSystemId(oci_database_db_system.test_db_system().id())
            .displayName(var_.channel_display_name())
            .isEnabled(var_.channel_is_enabled())
            .state(var_.channel_state())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_channels = oci.Mysql.get_channels(compartment_id=var["compartment_id"],
    channel_id=oci_mysql_channel["test_channel"]["id"],
    db_system_id=oci_database_db_system["test_db_system"]["id"],
    display_name=var["channel_display_name"],
    is_enabled=var["channel_is_enabled"],
    state=var["channel_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testChannels = oci.Mysql.getChannels({
    compartmentId: _var.compartment_id,
    channelId: oci_mysql_channel.test_channel.id,
    dbSystemId: oci_database_db_system.test_db_system.id,
    displayName: _var.channel_display_name,
    isEnabled: _var.channel_is_enabled,
    state: _var.channel_state,
});
variables:
  testChannels:
    Fn::Invoke:
      Function: oci:Mysql:getChannels
      Arguments:
        compartmentId: ${var.compartment_id}
        channelId: ${oci_mysql_channel.test_channel.id}
        dbSystemId: ${oci_database_db_system.test_db_system.id}
        displayName: ${var.channel_display_name}
        isEnabled: ${var.channel_is_enabled}
        state: ${var.channel_state}

Using getChannels

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 getChannels(args: GetChannelsArgs, opts?: InvokeOptions): Promise<GetChannelsResult>
function getChannelsOutput(args: GetChannelsOutputArgs, opts?: InvokeOptions): Output<GetChannelsResult>
def get_channels(channel_id: Optional[str] = None,
                 compartment_id: Optional[str] = None,
                 db_system_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[_mysql.GetChannelsFilter]] = None,
                 is_enabled: Optional[bool] = None,
                 state: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetChannelsResult
def get_channels_output(channel_id: Optional[pulumi.Input[str]] = None,
                 compartment_id: Optional[pulumi.Input[str]] = None,
                 db_system_id: Optional[pulumi.Input[str]] = None,
                 display_name: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[_mysql.GetChannelsFilterArgs]]]] = None,
                 is_enabled: Optional[pulumi.Input[bool]] = None,
                 state: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetChannelsResult]
func GetChannels(ctx *Context, args *GetChannelsArgs, opts ...InvokeOption) (*GetChannelsResult, error)
func GetChannelsOutput(ctx *Context, args *GetChannelsOutputArgs, opts ...InvokeOption) GetChannelsResultOutput

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

public static class GetChannels 
{
    public static Task<GetChannelsResult> InvokeAsync(GetChannelsArgs args, InvokeOptions? opts = null)
    public static Output<GetChannelsResult> Invoke(GetChannelsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetChannelsResult> getChannels(GetChannelsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Mysql/getChannels:getChannels
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string

The compartment OCID.

ChannelId string

The OCID of the Channel.

DbSystemId string

The DB System OCID.

DisplayName string

A filter to return only the resource matching the given display name exactly.

Filters List<GetChannelsFilter>
IsEnabled bool

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

State string

The LifecycleState of the Channel.

CompartmentId string

The compartment OCID.

ChannelId string

The OCID of the Channel.

DbSystemId string

The DB System OCID.

DisplayName string

A filter to return only the resource matching the given display name exactly.

Filters []GetChannelsFilter
IsEnabled bool

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

State string

The LifecycleState of the Channel.

compartmentId String

The compartment OCID.

channelId String

The OCID of the Channel.

dbSystemId String

The DB System OCID.

displayName String

A filter to return only the resource matching the given display name exactly.

filters List<GetChannelsFilter>
isEnabled Boolean

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

state String

The LifecycleState of the Channel.

compartmentId string

The compartment OCID.

channelId string

The OCID of the Channel.

dbSystemId string

The DB System OCID.

displayName string

A filter to return only the resource matching the given display name exactly.

filters GetChannelsFilter[]
isEnabled boolean

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

state string

The LifecycleState of the Channel.

compartment_id str

The compartment OCID.

channel_id str

The OCID of the Channel.

db_system_id str

The DB System OCID.

display_name str

A filter to return only the resource matching the given display name exactly.

filters GetChannelsFilter]
is_enabled bool

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

state str

The LifecycleState of the Channel.

compartmentId String

The compartment OCID.

channelId String

The OCID of the Channel.

dbSystemId String

The DB System OCID.

displayName String

A filter to return only the resource matching the given display name exactly.

filters List<Property Map>
isEnabled Boolean

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

state String

The LifecycleState of the Channel.

getChannels Result

The following output properties are available:

Channels List<GetChannelsChannel>

The list of channels.

CompartmentId string

The OCID of the compartment.

Id string

The provider-assigned unique ID for this managed resource.

ChannelId string
DbSystemId string

The OCID of the source DB System.

DisplayName string

The user-friendly name for the Channel. It does not have to be unique.

Filters List<GetChannelsFilter>
IsEnabled bool

Whether the Channel has been enabled by the user.

State string

The state of the Channel.

Channels []GetChannelsChannel

The list of channels.

CompartmentId string

The OCID of the compartment.

Id string

The provider-assigned unique ID for this managed resource.

ChannelId string
DbSystemId string

The OCID of the source DB System.

DisplayName string

The user-friendly name for the Channel. It does not have to be unique.

Filters []GetChannelsFilter
IsEnabled bool

Whether the Channel has been enabled by the user.

State string

The state of the Channel.

channels List<GetChannelsChannel>

The list of channels.

compartmentId String

The OCID of the compartment.

id String

The provider-assigned unique ID for this managed resource.

channelId String
dbSystemId String

The OCID of the source DB System.

displayName String

The user-friendly name for the Channel. It does not have to be unique.

filters List<GetChannelsFilter>
isEnabled Boolean

Whether the Channel has been enabled by the user.

state String

The state of the Channel.

channels GetChannelsChannel[]

The list of channels.

compartmentId string

The OCID of the compartment.

id string

The provider-assigned unique ID for this managed resource.

channelId string
dbSystemId string

The OCID of the source DB System.

displayName string

The user-friendly name for the Channel. It does not have to be unique.

filters GetChannelsFilter[]
isEnabled boolean

Whether the Channel has been enabled by the user.

state string

The state of the Channel.

channels GetChannelsChannel]

The list of channels.

compartment_id str

The OCID of the compartment.

id str

The provider-assigned unique ID for this managed resource.

channel_id str
db_system_id str

The OCID of the source DB System.

display_name str

The user-friendly name for the Channel. It does not have to be unique.

filters GetChannelsFilter]
is_enabled bool

Whether the Channel has been enabled by the user.

state str

The state of the Channel.

channels List<Property Map>

The list of channels.

compartmentId String

The OCID of the compartment.

id String

The provider-assigned unique ID for this managed resource.

channelId String
dbSystemId String

The OCID of the source DB System.

displayName String

The user-friendly name for the Channel. It does not have to be unique.

filters List<Property Map>
isEnabled Boolean

Whether the Channel has been enabled by the user.

state String

The state of the Channel.

Supporting Types

GetChannelsChannel

CompartmentId string

The compartment OCID.

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

A filter to return only the resource matching the given display name exactly.

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

The OCID of the Channel.

IsEnabled bool

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

LifecycleDetails string

A message describing the state of the Channel.

Sources List<GetChannelsChannelSource>

Parameters detailing how to provision the source for the given Channel.

State string

The LifecycleState of the Channel.

Targets List<GetChannelsChannelTarget>

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.

CompartmentId string

The compartment OCID.

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

A filter to return only the resource matching the given display name exactly.

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

The OCID of the Channel.

IsEnabled bool

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

LifecycleDetails string

A message describing the state of the Channel.

Sources []GetChannelsChannelSource

Parameters detailing how to provision the source for the given Channel.

State string

The LifecycleState of the Channel.

Targets []GetChannelsChannelTarget

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.

compartmentId String

The compartment OCID.

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

A filter to return only the resource matching the given display name exactly.

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

The OCID of the Channel.

isEnabled Boolean

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

lifecycleDetails String

A message describing the state of the Channel.

sources List<GetChannelsChannelSource>

Parameters detailing how to provision the source for the given Channel.

state String

The LifecycleState of the Channel.

targets List<GetChannelsChannelTarget>

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.

compartmentId string

The compartment OCID.

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

A filter to return only the resource matching the given display name exactly.

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

The OCID of the Channel.

isEnabled boolean

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

lifecycleDetails string

A message describing the state of the Channel.

sources GetChannelsChannelSource[]

Parameters detailing how to provision the source for the given Channel.

state string

The LifecycleState of the Channel.

targets GetChannelsChannelTarget[]

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.

compartment_id str

The compartment OCID.

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

A filter to return only the resource matching the given display name exactly.

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

The OCID of the Channel.

is_enabled bool

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

lifecycle_details str

A message describing the state of the Channel.

sources GetChannelsChannelSource]

Parameters detailing how to provision the source for the given Channel.

state str

The LifecycleState of the Channel.

targets GetChannelsChannelTarget]

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.

compartmentId String

The compartment OCID.

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

A filter to return only the resource matching the given display name exactly.

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

The OCID of the Channel.

isEnabled Boolean

If true, returns only Channels that are enabled. If false, returns only Channels that are disabled.

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

GetChannelsChannelSource

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

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 []GetChannelsChannelSourceSslCaCertificate

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

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 GetChannelsChannelSourceSslCaCertificate[]

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

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

GetChannelsChannelSourceSslCaCertificate

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.

GetChannelsChannelTarget

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 DB System OCID.

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 DB System OCID.

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 DB System OCID.

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 DB System OCID.

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 DB System OCID.

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 DB System OCID.

targetType String

The specific target identifier.

GetChannelsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.