Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. CloudListener
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

oci.DatabaseManagement.CloudListener

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Cloud Listener resource in Oracle Cloud Infrastructure Database Management service.

    Updates the cloud listener specified by cloudListenerId.

    Create CloudListener Resource

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

    Constructor syntax

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

@overload
def CloudListener(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  cloud_listener_id: Optional[str] = None,
                  cloud_connector_id: Optional[str] = None,
                  defined_tags: Optional[Mapping[str, str]] = None,
                  freeform_tags: Optional[Mapping[str, str]] = None)
    func NewCloudListener(ctx *Context, name string, args CloudListenerArgs, opts ...ResourceOption) (*CloudListener, error)
    public CloudListener(string name, CloudListenerArgs args, CustomResourceOptions? opts = null)
    public CloudListener(String name, CloudListenerArgs args)
public CloudListener(String name, CloudListenerArgs args, CustomResourceOptions options)

    type: oci:DatabaseManagement:CloudListener
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 CloudListenerArgs
    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 CloudListenerArgs
    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 CloudListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudListenerArgs
    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 cloudListenerResource = new Oci.DatabaseManagement.CloudListener("cloudListenerResource", new()
{
    CloudListenerId = "string",
    CloudConnectorId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
});

    example, err := databasemanagement.NewCloudListener(ctx, "cloudListenerResource", &databasemanagement.CloudListenerArgs{
	CloudListenerId:  pulumi.String("string"),
	CloudConnectorId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var cloudListenerResource = new CloudListener("cloudListenerResource", CloudListenerArgs.builder()
    .cloudListenerId("string")
    .cloudConnectorId("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .build());

    cloud_listener_resource = oci.databasemanagement.CloudListener("cloudListenerResource",
    cloud_listener_id="string",
    cloud_connector_id="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    })

    const cloudListenerResource = new oci.databasemanagement.CloudListener("cloudListenerResource", {
    cloudListenerId: "string",
    cloudConnectorId: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
});

    type: oci:DatabaseManagement:CloudListener
properties:
    cloudConnectorId: string
    cloudListenerId: string
    definedTags:
        string: string
    freeformTags:
        string: string

    CloudListener 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 CloudListener resource accepts the following input properties:

    CloudListenerId string
    The OCID of the cloud listener.
    CloudConnectorId string
    (Updatable) The OCID of the cloud connector.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, string>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    CloudListenerId string
    The OCID of the cloud listener.
    CloudConnectorId string
    (Updatable) The OCID of the cloud connector.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags map[string]string

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    cloudListenerId String
    The OCID of the cloud listener.
    cloudConnectorId String
    (Updatable) The OCID of the cloud connector.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String,String>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    cloudListenerId string
    The OCID of the cloud listener.
    cloudConnectorId string
    (Updatable) The OCID of the cloud connector.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: string}

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    cloud_listener_id str
    The OCID of the cloud listener.
    cloud_connector_id str
    (Updatable) The OCID of the cloud connector.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, str]

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    cloudListenerId String
    The OCID of the cloud listener.
    cloudConnectorId String
    (Updatable) The OCID of the cloud connector.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    Outputs

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

    AdditionalDetails Dictionary<string, string>
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    AdrHomeDirectory string
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    CloudDbHomeId string
    The OCID of the cloud DB home.
    CloudDbNodeId string
    The OCID of the cloud DB node.
    CloudDbSystemId string
    The OCID of the cloud DB system that the listener is a part of.
    CompartmentId string
    The OCID of the compartment in which the cloud database resides.
    ComponentName string
    The name of the cloud listener.
    DbaasId string
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    Endpoints List<CloudListenerEndpoint>
    The list of protocol addresses the listener is configured to listen on.
    HostName string
    The name of the host on which the cloud listener is running.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    ListenerAlias string
    The listener alias.
    ListenerOraLocation string
    The location of the listener configuration file listener.ora.
    ListenerType string
    The type of listener.
    LogDirectory string
    The destination directory of the listener log file.
    OracleHome string
    The Oracle home location of the listener.
    ServicedAsms List<CloudListenerServicedAsm>
    The list of ASMs that are serviced by the listener.
    ServicedDatabases List<CloudListenerServicedDatabase>
    The list of databases that are serviced by the listener.
    State string
    The current lifecycle state of the cloud listener.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the cloud listener was created.
    TimeUpdated string
    The date and time the cloud listener was last updated.
    TraceDirectory string
    The destination directory of the listener trace file.
    Version string
    The listener version.
    AdditionalDetails map[string]string
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    AdrHomeDirectory string
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    CloudDbHomeId string
    The OCID of the cloud DB home.
    CloudDbNodeId string
    The OCID of the cloud DB node.
    CloudDbSystemId string
    The OCID of the cloud DB system that the listener is a part of.
    CompartmentId string
    The OCID of the compartment in which the cloud database resides.
    ComponentName string
    The name of the cloud listener.
    DbaasId string
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    Endpoints []CloudListenerEndpoint
    The list of protocol addresses the listener is configured to listen on.
    HostName string
    The name of the host on which the cloud listener is running.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    ListenerAlias string
    The listener alias.
    ListenerOraLocation string
    The location of the listener configuration file listener.ora.
    ListenerType string
    The type of listener.
    LogDirectory string
    The destination directory of the listener log file.
    OracleHome string
    The Oracle home location of the listener.
    ServicedAsms []CloudListenerServicedAsm
    The list of ASMs that are serviced by the listener.
    ServicedDatabases []CloudListenerServicedDatabase
    The list of databases that are serviced by the listener.
    State string
    The current lifecycle state of the cloud listener.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the cloud listener was created.
    TimeUpdated string
    The date and time the cloud listener was last updated.
    TraceDirectory string
    The destination directory of the listener trace file.
    Version string
    The listener version.
    additionalDetails Map<String,String>
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    adrHomeDirectory String
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    cloudDbHomeId String
    The OCID of the cloud DB home.
    cloudDbNodeId String
    The OCID of the cloud DB node.
    cloudDbSystemId String
    The OCID of the cloud DB system that the listener is a part of.
    compartmentId String
    The OCID of the compartment in which the cloud database resides.
    componentName String
    The name of the cloud listener.
    dbaasId String
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    endpoints List<CloudListenerEndpoint>
    The list of protocol addresses the listener is configured to listen on.
    hostName String
    The name of the host on which the cloud listener is running.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    listenerAlias String
    The listener alias.
    listenerOraLocation String
    The location of the listener configuration file listener.ora.
    listenerType String
    The type of listener.
    logDirectory String
    The destination directory of the listener log file.
    oracleHome String
    The Oracle home location of the listener.
    servicedAsms List<CloudListenerServicedAsm>
    The list of ASMs that are serviced by the listener.
    servicedDatabases List<CloudListenerServicedDatabase>
    The list of databases that are serviced by the listener.
    state String
    The current lifecycle state of the cloud listener.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the cloud listener was created.
    timeUpdated String
    The date and time the cloud listener was last updated.
    traceDirectory String
    The destination directory of the listener trace file.
    version String
    The listener version.
    additionalDetails {[key: string]: string}
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    adrHomeDirectory string
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    cloudDbHomeId string
    The OCID of the cloud DB home.
    cloudDbNodeId string
    The OCID of the cloud DB node.
    cloudDbSystemId string
    The OCID of the cloud DB system that the listener is a part of.
    compartmentId string
    The OCID of the compartment in which the cloud database resides.
    componentName string
    The name of the cloud listener.
    dbaasId string
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    displayName string
    The user-friendly name for the database. The name does not have to be unique.
    endpoints CloudListenerEndpoint[]
    The list of protocol addresses the listener is configured to listen on.
    hostName string
    The name of the host on which the cloud listener is running.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    listenerAlias string
    The listener alias.
    listenerOraLocation string
    The location of the listener configuration file listener.ora.
    listenerType string
    The type of listener.
    logDirectory string
    The destination directory of the listener log file.
    oracleHome string
    The Oracle home location of the listener.
    servicedAsms CloudListenerServicedAsm[]
    The list of ASMs that are serviced by the listener.
    servicedDatabases CloudListenerServicedDatabase[]
    The list of databases that are serviced by the listener.
    state string
    The current lifecycle state of the cloud listener.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the cloud listener was created.
    timeUpdated string
    The date and time the cloud listener was last updated.
    traceDirectory string
    The destination directory of the listener trace file.
    version string
    The listener version.
    additional_details Mapping[str, str]
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    adr_home_directory str
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    cloud_db_home_id str
    The OCID of the cloud DB home.
    cloud_db_node_id str
    The OCID of the cloud DB node.
    cloud_db_system_id str
    The OCID of the cloud DB system that the listener is a part of.
    compartment_id str
    The OCID of the compartment in which the cloud database resides.
    component_name str
    The name of the cloud listener.
    dbaas_id str
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    display_name str
    The user-friendly name for the database. The name does not have to be unique.
    endpoints Sequence[CloudListenerEndpoint]
    The list of protocol addresses the listener is configured to listen on.
    host_name str
    The name of the host on which the cloud listener is running.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Additional information about the current lifecycle state.
    listener_alias str
    The listener alias.
    listener_ora_location str
    The location of the listener configuration file listener.ora.
    listener_type str
    The type of listener.
    log_directory str
    The destination directory of the listener log file.
    oracle_home str
    The Oracle home location of the listener.
    serviced_asms Sequence[CloudListenerServicedAsm]
    The list of ASMs that are serviced by the listener.
    serviced_databases Sequence[CloudListenerServicedDatabase]
    The list of databases that are serviced by the listener.
    state str
    The current lifecycle state of the cloud listener.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the cloud listener was created.
    time_updated str
    The date and time the cloud listener was last updated.
    trace_directory str
    The destination directory of the listener trace file.
    version str
    The listener version.
    additionalDetails Map<String>
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    adrHomeDirectory String
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    cloudDbHomeId String
    The OCID of the cloud DB home.
    cloudDbNodeId String
    The OCID of the cloud DB node.
    cloudDbSystemId String
    The OCID of the cloud DB system that the listener is a part of.
    compartmentId String
    The OCID of the compartment in which the cloud database resides.
    componentName String
    The name of the cloud listener.
    dbaasId String
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    endpoints List<Property Map>
    The list of protocol addresses the listener is configured to listen on.
    hostName String
    The name of the host on which the cloud listener is running.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    listenerAlias String
    The listener alias.
    listenerOraLocation String
    The location of the listener configuration file listener.ora.
    listenerType String
    The type of listener.
    logDirectory String
    The destination directory of the listener log file.
    oracleHome String
    The Oracle home location of the listener.
    servicedAsms List<Property Map>
    The list of ASMs that are serviced by the listener.
    servicedDatabases List<Property Map>
    The list of databases that are serviced by the listener.
    state String
    The current lifecycle state of the cloud listener.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the cloud listener was created.
    timeUpdated String
    The date and time the cloud listener was last updated.
    traceDirectory String
    The destination directory of the listener trace file.
    version String
    The listener version.

    Look up Existing CloudListener Resource

    Get an existing CloudListener 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?: CloudListenerState, opts?: CustomResourceOptions): CloudListener
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_details: Optional[Mapping[str, str]] = None,
        adr_home_directory: Optional[str] = None,
        cloud_connector_id: Optional[str] = None,
        cloud_db_home_id: Optional[str] = None,
        cloud_db_node_id: Optional[str] = None,
        cloud_db_system_id: Optional[str] = None,
        cloud_listener_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        component_name: Optional[str] = None,
        dbaas_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        endpoints: Optional[Sequence[CloudListenerEndpointArgs]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        host_name: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        listener_alias: Optional[str] = None,
        listener_ora_location: Optional[str] = None,
        listener_type: Optional[str] = None,
        log_directory: Optional[str] = None,
        oracle_home: Optional[str] = None,
        serviced_asms: Optional[Sequence[CloudListenerServicedAsmArgs]] = None,
        serviced_databases: Optional[Sequence[CloudListenerServicedDatabaseArgs]] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        trace_directory: Optional[str] = None,
        version: Optional[str] = None) -> CloudListener
    func GetCloudListener(ctx *Context, name string, id IDInput, state *CloudListenerState, opts ...ResourceOption) (*CloudListener, error)
    public static CloudListener Get(string name, Input<string> id, CloudListenerState? state, CustomResourceOptions? opts = null)
    public static CloudListener get(String name, Output<String> id, CloudListenerState state, CustomResourceOptions options)
    resources:  _:    type: oci:DatabaseManagement:CloudListener    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:
    AdditionalDetails Dictionary<string, string>
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    AdrHomeDirectory string
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    CloudConnectorId string
    (Updatable) The OCID of the cloud connector.
    CloudDbHomeId string
    The OCID of the cloud DB home.
    CloudDbNodeId string
    The OCID of the cloud DB node.
    CloudDbSystemId string
    The OCID of the cloud DB system that the listener is a part of.
    CloudListenerId string
    The OCID of the cloud listener.
    CompartmentId string
    The OCID of the compartment in which the cloud database resides.
    ComponentName string
    The name of the cloud listener.
    DbaasId string
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    Endpoints List<CloudListenerEndpoint>
    The list of protocol addresses the listener is configured to listen on.
    FreeformTags Dictionary<string, string>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    HostName string
    The name of the host on which the cloud listener is running.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    ListenerAlias string
    The listener alias.
    ListenerOraLocation string
    The location of the listener configuration file listener.ora.
    ListenerType string
    The type of listener.
    LogDirectory string
    The destination directory of the listener log file.
    OracleHome string
    The Oracle home location of the listener.
    ServicedAsms List<CloudListenerServicedAsm>
    The list of ASMs that are serviced by the listener.
    ServicedDatabases List<CloudListenerServicedDatabase>
    The list of databases that are serviced by the listener.
    State string
    The current lifecycle state of the cloud listener.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the cloud listener was created.
    TimeUpdated string
    The date and time the cloud listener was last updated.
    TraceDirectory string
    The destination directory of the listener trace file.
    Version string
    The listener version.
    AdditionalDetails map[string]string
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    AdrHomeDirectory string
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    CloudConnectorId string
    (Updatable) The OCID of the cloud connector.
    CloudDbHomeId string
    The OCID of the cloud DB home.
    CloudDbNodeId string
    The OCID of the cloud DB node.
    CloudDbSystemId string
    The OCID of the cloud DB system that the listener is a part of.
    CloudListenerId string
    The OCID of the cloud listener.
    CompartmentId string
    The OCID of the compartment in which the cloud database resides.
    ComponentName string
    The name of the cloud listener.
    DbaasId string
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    Endpoints []CloudListenerEndpointArgs
    The list of protocol addresses the listener is configured to listen on.
    FreeformTags map[string]string

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    HostName string
    The name of the host on which the cloud listener is running.
    LifecycleDetails string
    Additional information about the current lifecycle state.
    ListenerAlias string
    The listener alias.
    ListenerOraLocation string
    The location of the listener configuration file listener.ora.
    ListenerType string
    The type of listener.
    LogDirectory string
    The destination directory of the listener log file.
    OracleHome string
    The Oracle home location of the listener.
    ServicedAsms []CloudListenerServicedAsmArgs
    The list of ASMs that are serviced by the listener.
    ServicedDatabases []CloudListenerServicedDatabaseArgs
    The list of databases that are serviced by the listener.
    State string
    The current lifecycle state of the cloud listener.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the cloud listener was created.
    TimeUpdated string
    The date and time the cloud listener was last updated.
    TraceDirectory string
    The destination directory of the listener trace file.
    Version string
    The listener version.
    additionalDetails Map<String,String>
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    adrHomeDirectory String
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    cloudConnectorId String
    (Updatable) The OCID of the cloud connector.
    cloudDbHomeId String
    The OCID of the cloud DB home.
    cloudDbNodeId String
    The OCID of the cloud DB node.
    cloudDbSystemId String
    The OCID of the cloud DB system that the listener is a part of.
    cloudListenerId String
    The OCID of the cloud listener.
    compartmentId String
    The OCID of the compartment in which the cloud database resides.
    componentName String
    The name of the cloud listener.
    dbaasId String
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    endpoints List<CloudListenerEndpoint>
    The list of protocol addresses the listener is configured to listen on.
    freeformTags Map<String,String>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    hostName String
    The name of the host on which the cloud listener is running.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    listenerAlias String
    The listener alias.
    listenerOraLocation String
    The location of the listener configuration file listener.ora.
    listenerType String
    The type of listener.
    logDirectory String
    The destination directory of the listener log file.
    oracleHome String
    The Oracle home location of the listener.
    servicedAsms List<CloudListenerServicedAsm>
    The list of ASMs that are serviced by the listener.
    servicedDatabases List<CloudListenerServicedDatabase>
    The list of databases that are serviced by the listener.
    state String
    The current lifecycle state of the cloud listener.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the cloud listener was created.
    timeUpdated String
    The date and time the cloud listener was last updated.
    traceDirectory String
    The destination directory of the listener trace file.
    version String
    The listener version.
    additionalDetails {[key: string]: string}
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    adrHomeDirectory string
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    cloudConnectorId string
    (Updatable) The OCID of the cloud connector.
    cloudDbHomeId string
    The OCID of the cloud DB home.
    cloudDbNodeId string
    The OCID of the cloud DB node.
    cloudDbSystemId string
    The OCID of the cloud DB system that the listener is a part of.
    cloudListenerId string
    The OCID of the cloud listener.
    compartmentId string
    The OCID of the compartment in which the cloud database resides.
    componentName string
    The name of the cloud listener.
    dbaasId string
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    The user-friendly name for the database. The name does not have to be unique.
    endpoints CloudListenerEndpoint[]
    The list of protocol addresses the listener is configured to listen on.
    freeformTags {[key: string]: string}

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    hostName string
    The name of the host on which the cloud listener is running.
    lifecycleDetails string
    Additional information about the current lifecycle state.
    listenerAlias string
    The listener alias.
    listenerOraLocation string
    The location of the listener configuration file listener.ora.
    listenerType string
    The type of listener.
    logDirectory string
    The destination directory of the listener log file.
    oracleHome string
    The Oracle home location of the listener.
    servicedAsms CloudListenerServicedAsm[]
    The list of ASMs that are serviced by the listener.
    servicedDatabases CloudListenerServicedDatabase[]
    The list of databases that are serviced by the listener.
    state string
    The current lifecycle state of the cloud listener.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the cloud listener was created.
    timeUpdated string
    The date and time the cloud listener was last updated.
    traceDirectory string
    The destination directory of the listener trace file.
    version string
    The listener version.
    additional_details Mapping[str, str]
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    adr_home_directory str
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    cloud_connector_id str
    (Updatable) The OCID of the cloud connector.
    cloud_db_home_id str
    The OCID of the cloud DB home.
    cloud_db_node_id str
    The OCID of the cloud DB node.
    cloud_db_system_id str
    The OCID of the cloud DB system that the listener is a part of.
    cloud_listener_id str
    The OCID of the cloud listener.
    compartment_id str
    The OCID of the compartment in which the cloud database resides.
    component_name str
    The name of the cloud listener.
    dbaas_id str
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    The user-friendly name for the database. The name does not have to be unique.
    endpoints Sequence[CloudListenerEndpointArgs]
    The list of protocol addresses the listener is configured to listen on.
    freeform_tags Mapping[str, str]

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    host_name str
    The name of the host on which the cloud listener is running.
    lifecycle_details str
    Additional information about the current lifecycle state.
    listener_alias str
    The listener alias.
    listener_ora_location str
    The location of the listener configuration file listener.ora.
    listener_type str
    The type of listener.
    log_directory str
    The destination directory of the listener log file.
    oracle_home str
    The Oracle home location of the listener.
    serviced_asms Sequence[CloudListenerServicedAsmArgs]
    The list of ASMs that are serviced by the listener.
    serviced_databases Sequence[CloudListenerServicedDatabaseArgs]
    The list of databases that are serviced by the listener.
    state str
    The current lifecycle state of the cloud listener.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the cloud listener was created.
    time_updated str
    The date and time the cloud listener was last updated.
    trace_directory str
    The destination directory of the listener trace file.
    version str
    The listener version.
    additionalDetails Map<String>
    The additional details of the cloud listener defined in {"key": "value"} format. Example: {"bar-key": "value"}
    adrHomeDirectory String
    The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
    cloudConnectorId String
    (Updatable) The OCID of the cloud connector.
    cloudDbHomeId String
    The OCID of the cloud DB home.
    cloudDbNodeId String
    The OCID of the cloud DB node.
    cloudDbSystemId String
    The OCID of the cloud DB system that the listener is a part of.
    cloudListenerId String
    The OCID of the cloud listener.
    compartmentId String
    The OCID of the compartment in which the cloud database resides.
    componentName String
    The name of the cloud listener.
    dbaasId String
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    endpoints List<Property Map>
    The list of protocol addresses the listener is configured to listen on.
    freeformTags Map<String>

    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

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

    hostName String
    The name of the host on which the cloud listener is running.
    lifecycleDetails String
    Additional information about the current lifecycle state.
    listenerAlias String
    The listener alias.
    listenerOraLocation String
    The location of the listener configuration file listener.ora.
    listenerType String
    The type of listener.
    logDirectory String
    The destination directory of the listener log file.
    oracleHome String
    The Oracle home location of the listener.
    servicedAsms List<Property Map>
    The list of ASMs that are serviced by the listener.
    servicedDatabases List<Property Map>
    The list of databases that are serviced by the listener.
    state String
    The current lifecycle state of the cloud listener.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the cloud listener was created.
    timeUpdated String
    The date and time the cloud listener was last updated.
    traceDirectory String
    The destination directory of the listener trace file.
    version String
    The listener version.

    Supporting Types

    CloudListenerEndpoint, CloudListenerEndpointArgs

    Host string
    The host name or IP address.
    Key string
    The unique name of the service.
    Port int
    The port number.
    Protocol string
    The listener protocol.
    Services List<string>
    The list of services registered with the listener.
    Host string
    The host name or IP address.
    Key string
    The unique name of the service.
    Port int
    The port number.
    Protocol string
    The listener protocol.
    Services []string
    The list of services registered with the listener.
    host String
    The host name or IP address.
    key String
    The unique name of the service.
    port Integer
    The port number.
    protocol String
    The listener protocol.
    services List<String>
    The list of services registered with the listener.
    host string
    The host name or IP address.
    key string
    The unique name of the service.
    port number
    The port number.
    protocol string
    The listener protocol.
    services string[]
    The list of services registered with the listener.
    host str
    The host name or IP address.
    key str
    The unique name of the service.
    port int
    The port number.
    protocol str
    The listener protocol.
    services Sequence[str]
    The list of services registered with the listener.
    host String
    The host name or IP address.
    key String
    The unique name of the service.
    port Number
    The port number.
    protocol String
    The listener protocol.
    services List<String>
    The list of services registered with the listener.

    CloudListenerServicedAsm, CloudListenerServicedAsmArgs

    CompartmentId string
    The OCID of the compartment in which the cloud database resides.
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    Id string
    The OCID of the cloud database.
    CompartmentId string
    The OCID of the compartment in which the cloud database resides.
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    Id string
    The OCID of the cloud database.
    compartmentId String
    The OCID of the compartment in which the cloud database resides.
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    id String
    The OCID of the cloud database.
    compartmentId string
    The OCID of the compartment in which the cloud database resides.
    displayName string
    The user-friendly name for the database. The name does not have to be unique.
    id string
    The OCID of the cloud database.
    compartment_id str
    The OCID of the compartment in which the cloud database resides.
    display_name str
    The user-friendly name for the database. The name does not have to be unique.
    id str
    The OCID of the cloud database.
    compartmentId String
    The OCID of the compartment in which the cloud database resides.
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    id String
    The OCID of the cloud database.

    CloudListenerServicedDatabase, CloudListenerServicedDatabaseArgs

    CompartmentId string
    The OCID of the compartment in which the cloud database resides.
    DatabaseSubType string
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    DatabaseType string
    The type of Oracle Database installation.
    DbUniqueName string
    The unique name of the cloud database.
    DbaasId string
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    Id string
    The OCID of the cloud database.
    IsManaged bool
    Indicates whether the database is a Managed Database or not.
    CompartmentId string
    The OCID of the compartment in which the cloud database resides.
    DatabaseSubType string
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    DatabaseType string
    The type of Oracle Database installation.
    DbUniqueName string
    The unique name of the cloud database.
    DbaasId string
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    DisplayName string
    The user-friendly name for the database. The name does not have to be unique.
    Id string
    The OCID of the cloud database.
    IsManaged bool
    Indicates whether the database is a Managed Database or not.
    compartmentId String
    The OCID of the compartment in which the cloud database resides.
    databaseSubType String
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    databaseType String
    The type of Oracle Database installation.
    dbUniqueName String
    The unique name of the cloud database.
    dbaasId String
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    id String
    The OCID of the cloud database.
    isManaged Boolean
    Indicates whether the database is a Managed Database or not.
    compartmentId string
    The OCID of the compartment in which the cloud database resides.
    databaseSubType string
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    databaseType string
    The type of Oracle Database installation.
    dbUniqueName string
    The unique name of the cloud database.
    dbaasId string
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    displayName string
    The user-friendly name for the database. The name does not have to be unique.
    id string
    The OCID of the cloud database.
    isManaged boolean
    Indicates whether the database is a Managed Database or not.
    compartment_id str
    The OCID of the compartment in which the cloud database resides.
    database_sub_type str
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    database_type str
    The type of Oracle Database installation.
    db_unique_name str
    The unique name of the cloud database.
    dbaas_id str
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    display_name str
    The user-friendly name for the database. The name does not have to be unique.
    id str
    The OCID of the cloud database.
    is_managed bool
    Indicates whether the database is a Managed Database or not.
    compartmentId String
    The OCID of the compartment in which the cloud database resides.
    databaseSubType String
    The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
    databaseType String
    The type of Oracle Database installation.
    dbUniqueName String
    The unique name of the cloud database.
    dbaasId String
    The OCID of the existing Dbaas Oracle Cloud Infrastructure resource matching the discovered DB system component.
    displayName String
    The user-friendly name for the database. The name does not have to be unique.
    id String
    The OCID of the cloud database.
    isManaged Boolean
    Indicates whether the database is a Managed Database or not.

    Import

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

    $ pulumi import oci:DatabaseManagement/cloudListener:CloudListener test_cloud_listener "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 v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
    pulumi/pulumi-oci