Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Mysql
  5. Channel
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.Mysql.Channel

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Channel resource in Oracle Cloud Infrastructure MySQL Database service.

    Creates a Channel to establish replication from a source to a target.

    Create Channel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Channel(name: string, args: ChannelArgs, opts?: CustomResourceOptions);
    @overload
def Channel(resource_name: str,
            args: ChannelArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Channel(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            source: Optional[ChannelSourceArgs] = None,
            target: Optional[ChannelTargetArgs] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            is_enabled: Optional[bool] = None)
    func NewChannel(ctx *Context, name string, args ChannelArgs, opts ...ResourceOption) (*Channel, error)
    public Channel(string name, ChannelArgs args, CustomResourceOptions? opts = null)
    public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)

    type: oci:Mysql:Channel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var channelResource = new Oci.Mysql.Channel("channelResource", new()
{
    Source = new Oci.Mysql.Inputs.ChannelSourceArgs
    {
        Hostname = "string",
        Password = "string",
        SourceType = "string",
        SslMode = "string",
        Username = "string",
        AnonymousTransactionsHandling = new Oci.Mysql.Inputs.ChannelSourceAnonymousTransactionsHandlingArgs
        {
            Policy = "string",
            LastConfiguredLogFilename = "string",
            LastConfiguredLogOffset = "string",
            Uuid = "string",
        },
        Port = 0,
        SslCaCertificate = new Oci.Mysql.Inputs.ChannelSourceSslCaCertificateArgs
        {
            CertificateType = "string",
            Contents = "string",
        },
    },
    Target = new Oci.Mysql.Inputs.ChannelTargetArgs
    {
        DbSystemId = "string",
        TargetType = "string",
        ApplierUsername = "string",
        ChannelName = "string",
        DelayInSeconds = 0,
        Filters = new[]
        {
            new Oci.Mysql.Inputs.ChannelTargetFilterArgs
            {
                Type = "string",
                Value = "string",
            },
        },
        TablesWithoutPrimaryKeyHandling = "string",
    },
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsEnabled = false,
});

    example, err := mysql.NewChannel(ctx, "channelResource", &mysql.ChannelArgs{
	Source: &mysql.ChannelSourceArgs{
		Hostname:   pulumi.String("string"),
		Password:   pulumi.String("string"),
		SourceType: pulumi.String("string"),
		SslMode:    pulumi.String("string"),
		Username:   pulumi.String("string"),
		AnonymousTransactionsHandling: &mysql.ChannelSourceAnonymousTransactionsHandlingArgs{
			Policy:                    pulumi.String("string"),
			LastConfiguredLogFilename: pulumi.String("string"),
			LastConfiguredLogOffset:   pulumi.String("string"),
			Uuid:                      pulumi.String("string"),
		},
		Port: pulumi.Int(0),
		SslCaCertificate: &mysql.ChannelSourceSslCaCertificateArgs{
			CertificateType: pulumi.String("string"),
			Contents:        pulumi.String("string"),
		},
	},
	Target: &mysql.ChannelTargetArgs{
		DbSystemId:      pulumi.String("string"),
		TargetType:      pulumi.String("string"),
		ApplierUsername: pulumi.String("string"),
		ChannelName:     pulumi.String("string"),
		DelayInSeconds:  pulumi.Int(0),
		Filters: mysql.ChannelTargetFilterArray{
			&mysql.ChannelTargetFilterArgs{
				Type:  pulumi.String("string"),
				Value: pulumi.String("string"),
			},
		},
		TablesWithoutPrimaryKeyHandling: pulumi.String("string"),
	},
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsEnabled: pulumi.Bool(false),
})

    var channelResource = new Channel("channelResource", ChannelArgs.builder()
    .source(ChannelSourceArgs.builder()
        .hostname("string")
        .password("string")
        .sourceType("string")
        .sslMode("string")
        .username("string")
        .anonymousTransactionsHandling(ChannelSourceAnonymousTransactionsHandlingArgs.builder()
            .policy("string")
            .lastConfiguredLogFilename("string")
            .lastConfiguredLogOffset("string")
            .uuid("string")
            .build())
        .port(0)
        .sslCaCertificate(ChannelSourceSslCaCertificateArgs.builder()
            .certificateType("string")
            .contents("string")
            .build())
        .build())
    .target(ChannelTargetArgs.builder()
        .dbSystemId("string")
        .targetType("string")
        .applierUsername("string")
        .channelName("string")
        .delayInSeconds(0)
        .filters(ChannelTargetFilterArgs.builder()
            .type("string")
            .value("string")
            .build())
        .tablesWithoutPrimaryKeyHandling("string")
        .build())
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .isEnabled(false)
    .build());

    channel_resource = oci.mysql.Channel("channelResource",
    source={
        "hostname": "string",
        "password": "string",
        "source_type": "string",
        "ssl_mode": "string",
        "username": "string",
        "anonymous_transactions_handling": {
            "policy": "string",
            "last_configured_log_filename": "string",
            "last_configured_log_offset": "string",
            "uuid": "string",
        },
        "port": 0,
        "ssl_ca_certificate": {
            "certificate_type": "string",
            "contents": "string",
        },
    },
    target={
        "db_system_id": "string",
        "target_type": "string",
        "applier_username": "string",
        "channel_name": "string",
        "delay_in_seconds": 0,
        "filters": [{
            "type": "string",
            "value": "string",
        }],
        "tables_without_primary_key_handling": "string",
    },
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    is_enabled=False)

    const channelResource = new oci.mysql.Channel("channelResource", {
    source: {
        hostname: "string",
        password: "string",
        sourceType: "string",
        sslMode: "string",
        username: "string",
        anonymousTransactionsHandling: {
            policy: "string",
            lastConfiguredLogFilename: "string",
            lastConfiguredLogOffset: "string",
            uuid: "string",
        },
        port: 0,
        sslCaCertificate: {
            certificateType: "string",
            contents: "string",
        },
    },
    target: {
        dbSystemId: "string",
        targetType: "string",
        applierUsername: "string",
        channelName: "string",
        delayInSeconds: 0,
        filters: [{
            type: "string",
            value: "string",
        }],
        tablesWithoutPrimaryKeyHandling: "string",
    },
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    isEnabled: false,
});

    type: oci:Mysql:Channel
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    isEnabled: false
    source:
        anonymousTransactionsHandling:
            lastConfiguredLogFilename: string
            lastConfiguredLogOffset: string
            policy: string
            uuid: string
        hostname: string
        password: string
        port: 0
        sourceType: string
        sslCaCertificate:
            certificateType: string
            contents: string
        sslMode: string
        username: string
    target:
        applierUsername: string
        channelName: string
        dbSystemId: string
        delayInSeconds: 0
        filters:
            - type: string
              value: string
        tablesWithoutPrimaryKeyHandling: string
        targetType: string

    Channel Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Channel resource accepts the following input properties:

    Source ChannelSource
    (Updatable) Parameters detailing how to provision the source for the given Channel.
    Target ChannelTarget
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    CompartmentId string
    The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) User provided information about the Channel.
    DisplayName string
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsEnabled bool
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    Source ChannelSourceArgs
    (Updatable) Parameters detailing how to provision the source for the given Channel.
    Target ChannelTargetArgs
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    CompartmentId string
    The OCID of the compartment.
    DefinedTags map[string]string
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) User provided information about the Channel.
    DisplayName string
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsEnabled bool
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    source ChannelSource
    (Updatable) Parameters detailing how to provision the source for the given Channel.
    target ChannelTarget
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    compartmentId String
    The OCID of the compartment.
    definedTags Map<String,String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) User provided information about the Channel.
    displayName String
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isEnabled Boolean
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    source ChannelSource
    (Updatable) Parameters detailing how to provision the source for the given Channel.
    target ChannelTarget
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    compartmentId string
    The OCID of the compartment.
    definedTags {[key: string]: string}
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) User provided information about the Channel.
    displayName string
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isEnabled boolean
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    source ChannelSourceArgs
    (Updatable) Parameters detailing how to provision the source for the given Channel.
    target ChannelTargetArgs
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    compartment_id str
    The OCID of the compartment.
    defined_tags Mapping[str, str]
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) User provided information about the Channel.
    display_name str
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    is_enabled bool
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    source Property Map
    (Updatable) Parameters detailing how to provision the source for the given Channel.
    target Property Map
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    compartmentId String
    The OCID of the compartment.
    definedTags Map<String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) User provided information about the Channel.
    displayName String
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    freeformTags Map<String>
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isEnabled Boolean
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Channel resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the state of the 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"}
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the state of the 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"}
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the state of the 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"}
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message describing the state of the 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"}
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message describing the state of the 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"}
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the state of the 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"}
    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.

    Look up Existing Channel Resource

    Get an existing Channel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ChannelState, opts?: CustomResourceOptions): Channel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_enabled: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        source: Optional[ChannelSourceArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        target: Optional[ChannelTargetArgs] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Channel
    func GetChannel(ctx *Context, name string, id IDInput, state *ChannelState, opts ...ResourceOption) (*Channel, error)
    public static Channel Get(string name, Input<string> id, ChannelState? state, CustomResourceOptions? opts = null)
    public static Channel get(String name, Output<String> id, ChannelState state, CustomResourceOptions options)
    resources:  _:    type: oci:Mysql:Channel    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) User provided information about the Channel.
    DisplayName string
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsEnabled bool
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    LifecycleDetails string
    A message describing the state of the Channel.
    Source ChannelSource
    (Updatable) 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"}
    Target ChannelTarget
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    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 OCID of the compartment.
    DefinedTags map[string]string
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) User provided information about the Channel.
    DisplayName string
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsEnabled bool
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    LifecycleDetails string
    A message describing the state of the Channel.
    Source ChannelSourceArgs
    (Updatable) 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"}
    Target ChannelTargetArgs
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    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 OCID of the compartment.
    definedTags Map<String,String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) User provided information about the Channel.
    displayName String
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isEnabled Boolean
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    lifecycleDetails String
    A message describing the state of the Channel.
    source ChannelSource
    (Updatable) 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"}
    target ChannelTarget
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    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 OCID of the compartment.
    definedTags {[key: string]: string}
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) User provided information about the Channel.
    displayName string
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isEnabled boolean
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    lifecycleDetails string
    A message describing the state of the Channel.
    source ChannelSource
    (Updatable) 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"}
    target ChannelTarget
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    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 OCID of the compartment.
    defined_tags Mapping[str, str]
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) User provided information about the Channel.
    display_name str
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    is_enabled bool
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    lifecycle_details str
    A message describing the state of the Channel.
    source ChannelSourceArgs
    (Updatable) 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"}
    target ChannelTargetArgs
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    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 OCID of the compartment.
    definedTags Map<String>
    (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) User provided information about the Channel.
    displayName String
    (Updatable) The user-friendly name for the Channel. It does not have to be unique.
    freeformTags Map<String>
    (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isEnabled Boolean
    (Updatable) Whether the Channel should be enabled upon creation. If set to true, the Channel will be asynchronously started as a result of the create Channel operation.
    lifecycleDetails String
    A message describing the state of the Channel.
    source Property Map
    (Updatable) 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"}
    target Property Map
    (Updatable) Parameters detailing how to provision the target for the given Channel.
    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

    ChannelSource, ChannelSourceArgs

    Hostname string
    (Updatable) The network address of the MySQL instance.
    Password string
    (Updatable) The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.
    SourceType string
    (Updatable) The specific source identifier.
    SslMode string
    (Updatable) The SSL mode of the Channel.
    Username string
    (Updatable) 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
    AnonymousTransactionsHandling ChannelSourceAnonymousTransactionsHandling
    (Updatable) 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.
    Port int
    (Updatable) The port the source MySQL instance listens on.
    SslCaCertificate ChannelSourceSslCaCertificate
    (Updatable) The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
    Hostname string
    (Updatable) The network address of the MySQL instance.
    Password string
    (Updatable) The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.
    SourceType string
    (Updatable) The specific source identifier.
    SslMode string
    (Updatable) The SSL mode of the Channel.
    Username string
    (Updatable) 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
    AnonymousTransactionsHandling ChannelSourceAnonymousTransactionsHandling
    (Updatable) 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.
    Port int
    (Updatable) The port the source MySQL instance listens on.
    SslCaCertificate ChannelSourceSslCaCertificate
    (Updatable) The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
    hostname String
    (Updatable) The network address of the MySQL instance.
    password String
    (Updatable) The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.
    sourceType String
    (Updatable) The specific source identifier.
    sslMode String
    (Updatable) The SSL mode of the Channel.
    username String
    (Updatable) 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
    anonymousTransactionsHandling ChannelSourceAnonymousTransactionsHandling
    (Updatable) 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.
    port Integer
    (Updatable) The port the source MySQL instance listens on.
    sslCaCertificate ChannelSourceSslCaCertificate
    (Updatable) The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
    hostname string
    (Updatable) The network address of the MySQL instance.
    password string
    (Updatable) The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.
    sourceType string
    (Updatable) The specific source identifier.
    sslMode string
    (Updatable) The SSL mode of the Channel.
    username string
    (Updatable) 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
    anonymousTransactionsHandling ChannelSourceAnonymousTransactionsHandling
    (Updatable) 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.
    port number
    (Updatable) The port the source MySQL instance listens on.
    sslCaCertificate ChannelSourceSslCaCertificate
    (Updatable) The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
    hostname str
    (Updatable) The network address of the MySQL instance.
    password str
    (Updatable) The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.
    source_type str
    (Updatable) The specific source identifier.
    ssl_mode str
    (Updatable) The SSL mode of the Channel.
    username str
    (Updatable) 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_handling ChannelSourceAnonymousTransactionsHandling
    (Updatable) 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.
    port int
    (Updatable) The port the source MySQL instance listens on.
    ssl_ca_certificate ChannelSourceSslCaCertificate
    (Updatable) The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
    hostname String
    (Updatable) The network address of the MySQL instance.
    password String
    (Updatable) The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.
    sourceType String
    (Updatable) The specific source identifier.
    sslMode String
    (Updatable) The SSL mode of the Channel.
    username String
    (Updatable) 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
    anonymousTransactionsHandling Property Map
    (Updatable) 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.
    port Number
    (Updatable) The port the source MySQL instance listens on.
    sslCaCertificate Property Map
    (Updatable) The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.

    ChannelSourceAnonymousTransactionsHandling, ChannelSourceAnonymousTransactionsHandlingArgs

    Policy string
    (Updatable) Specifies how the replication channel handles anonymous transactions.
    LastConfiguredLogFilename string
    (Updatable) 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
    (Updatable) 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.
    Uuid string
    (Updatable) 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.
    Policy string
    (Updatable) Specifies how the replication channel handles anonymous transactions.
    LastConfiguredLogFilename string
    (Updatable) 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
    (Updatable) 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.
    Uuid string
    (Updatable) 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.
    policy String
    (Updatable) Specifies how the replication channel handles anonymous transactions.
    lastConfiguredLogFilename String
    (Updatable) 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
    (Updatable) 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.
    uuid String
    (Updatable) 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.
    policy string
    (Updatable) Specifies how the replication channel handles anonymous transactions.
    lastConfiguredLogFilename string
    (Updatable) 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
    (Updatable) 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.
    uuid string
    (Updatable) 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.
    policy str
    (Updatable) Specifies how the replication channel handles anonymous transactions.
    last_configured_log_filename str
    (Updatable) 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
    (Updatable) 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.
    uuid str
    (Updatable) 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.
    policy String
    (Updatable) Specifies how the replication channel handles anonymous transactions.
    lastConfiguredLogFilename String
    (Updatable) 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
    (Updatable) 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.
    uuid String
    (Updatable) 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.

    ChannelSourceSslCaCertificate, ChannelSourceSslCaCertificateArgs

    CertificateType string
    (Updatable) The type of CA certificate.
    Contents string
    (Updatable) The string containing the CA certificate in PEM format.
    CertificateType string
    (Updatable) The type of CA certificate.
    Contents string
    (Updatable) The string containing the CA certificate in PEM format.
    certificateType String
    (Updatable) The type of CA certificate.
    contents String
    (Updatable) The string containing the CA certificate in PEM format.
    certificateType string
    (Updatable) The type of CA certificate.
    contents string
    (Updatable) The string containing the CA certificate in PEM format.
    certificate_type str
    (Updatable) The type of CA certificate.
    contents str
    (Updatable) The string containing the CA certificate in PEM format.
    certificateType String
    (Updatable) The type of CA certificate.
    contents String
    (Updatable) The string containing the CA certificate in PEM format.

    ChannelTarget, ChannelTargetArgs

    DbSystemId string
    The OCID of the target DB System.
    TargetType string

    (Updatable) The specific target identifier.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    ApplierUsername string
    (Updatable) The username for the replication applier of the target MySQL DB System.
    ChannelName string
    (Updatable) 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.
    DelayInSeconds int
    (Updatable) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
    Filters List<ChannelTargetFilter>
    (Updatable) Replication filter rules to be applied at the DB System Channel target.
    TablesWithoutPrimaryKeyHandling string
    (Updatable) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. The default value is set to ALLOW.
    DbSystemId string
    The OCID of the target DB System.
    TargetType string

    (Updatable) The specific target identifier.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    ApplierUsername string
    (Updatable) The username for the replication applier of the target MySQL DB System.
    ChannelName string
    (Updatable) 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.
    DelayInSeconds int
    (Updatable) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
    Filters []ChannelTargetFilter
    (Updatable) Replication filter rules to be applied at the DB System Channel target.
    TablesWithoutPrimaryKeyHandling string
    (Updatable) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. The default value is set to ALLOW.
    dbSystemId String
    The OCID of the target DB System.
    targetType String

    (Updatable) The specific target identifier.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    applierUsername String
    (Updatable) The username for the replication applier of the target MySQL DB System.
    channelName String
    (Updatable) 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.
    delayInSeconds Integer
    (Updatable) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
    filters List<ChannelTargetFilter>
    (Updatable) Replication filter rules to be applied at the DB System Channel target.
    tablesWithoutPrimaryKeyHandling String
    (Updatable) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. The default value is set to ALLOW.
    dbSystemId string
    The OCID of the target DB System.
    targetType string

    (Updatable) The specific target identifier.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    applierUsername string
    (Updatable) The username for the replication applier of the target MySQL DB System.
    channelName string
    (Updatable) 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.
    delayInSeconds number
    (Updatable) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
    filters ChannelTargetFilter[]
    (Updatable) Replication filter rules to be applied at the DB System Channel target.
    tablesWithoutPrimaryKeyHandling string
    (Updatable) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. The default value is set to ALLOW.
    db_system_id str
    The OCID of the target DB System.
    target_type str

    (Updatable) The specific target identifier.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    applier_username str
    (Updatable) The username for the replication applier of the target MySQL DB System.
    channel_name str
    (Updatable) 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.
    delay_in_seconds int
    (Updatable) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
    filters Sequence[ChannelTargetFilter]
    (Updatable) Replication filter rules to be applied at the DB System Channel target.
    tables_without_primary_key_handling str
    (Updatable) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. The default value is set to ALLOW.
    dbSystemId String
    The OCID of the target DB System.
    targetType String

    (Updatable) The specific target identifier.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    applierUsername String
    (Updatable) The username for the replication applier of the target MySQL DB System.
    channelName String
    (Updatable) 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.
    delayInSeconds Number
    (Updatable) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
    filters List<Property Map>
    (Updatable) Replication filter rules to be applied at the DB System Channel target.
    tablesWithoutPrimaryKeyHandling String
    (Updatable) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. The default value is set to ALLOW.

    ChannelTargetFilter, ChannelTargetFilterArgs

    Type string

    (Updatable) The type of the filter rule.

    For details on each type, see Replication Filtering Rules

    Value string
    (Updatable) 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

    (Updatable) The type of the filter rule.

    For details on each type, see Replication Filtering Rules

    Value string
    (Updatable) 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

    (Updatable) The type of the filter rule.

    For details on each type, see Replication Filtering Rules

    value String
    (Updatable) 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

    (Updatable) The type of the filter rule.

    For details on each type, see Replication Filtering Rules

    value string
    (Updatable) 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

    (Updatable) The type of the filter rule.

    For details on each type, see Replication Filtering Rules

    value str
    (Updatable) 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

    (Updatable) The type of the filter rule.

    For details on each type, see Replication Filtering Rules

    value String
    (Updatable) 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.

    Import

    Channels can be imported using the id, e.g.

    $ pulumi import oci:Mysql/channel:Channel test_channel "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci