1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DatabaseManagement
  5. ExternalListener
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi

oci.DatabaseManagement.ExternalListener

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi

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

    Updates the external listener specified by externalListenerId.

    Create ExternalListener Resource

    new ExternalListener(name: string, args: ExternalListenerArgs, opts?: CustomResourceOptions);
    @overload
    def ExternalListener(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         external_connector_id: Optional[str] = None,
                         external_listener_id: Optional[str] = None)
    @overload
    def ExternalListener(resource_name: str,
                         args: ExternalListenerArgs,
                         opts: Optional[ResourceOptions] = None)
    func NewExternalListener(ctx *Context, name string, args ExternalListenerArgs, opts ...ResourceOption) (*ExternalListener, error)
    public ExternalListener(string name, ExternalListenerArgs args, CustomResourceOptions? opts = null)
    public ExternalListener(String name, ExternalListenerArgs args)
    public ExternalListener(String name, ExternalListenerArgs args, CustomResourceOptions options)
    
    type: oci:DatabaseManagement:ExternalListener
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ExternalListenerArgs
    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 ExternalListenerArgs
    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 ExternalListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExternalListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExternalListenerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ExternalListener Resource Properties

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

    Inputs

    The ExternalListener resource accepts the following input properties:

    ExternalListenerId string

    The OCID of the external listener.

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

    ExternalConnectorId string

    (Updatable) The OCID of the external connector.

    ExternalListenerId string

    The OCID of the external listener.

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

    ExternalConnectorId string

    (Updatable) The OCID of the external connector.

    externalListenerId String

    The OCID of the external listener.

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

    externalConnectorId String

    (Updatable) The OCID of the external connector.

    externalListenerId string

    The OCID of the external listener.

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

    externalConnectorId string

    (Updatable) The OCID of the external connector.

    external_listener_id str

    The OCID of the external listener.

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

    external_connector_id str

    (Updatable) The OCID of the external connector.

    externalListenerId String

    The OCID of the external listener.

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

    externalConnectorId String

    (Updatable) The OCID of the external connector.

    Outputs

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

    AdditionalDetails Dictionary<string, object>

    The additional details of the external 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.

    CompartmentId string

    The OCID of the compartment in which the external database resides.

    ComponentName string

    The name of the external listener.

    DisplayName string

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

    Endpoints List<ExternalListenerEndpoint>

    The list of protocol addresses the listener is configured to listen on.

    ExternalDbHomeId string

    The OCID of the external DB home.

    ExternalDbNodeId string

    The OCID of the external DB node.

    ExternalDbSystemId string

    The OCID of the external DB system that the listener is a part of.

    HostName string

    The name of the host on which the external 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<ExternalListenerServicedAsm>

    The list of ASMs that are serviced by the listener.

    ServicedDatabases List<ExternalListenerServicedDatabase>

    The list of databases that are serviced by the listener.

    State string

    The current lifecycle state of the external listener.

    TimeCreated string

    The date and time the external listener was created.

    TimeUpdated string

    The date and time the external listener was last updated.

    TraceDirectory string

    The destination directory of the listener trace file.

    Version string

    The listener version.

    AdditionalDetails map[string]interface{}

    The additional details of the external 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.

    CompartmentId string

    The OCID of the compartment in which the external database resides.

    ComponentName string

    The name of the external listener.

    DisplayName string

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

    Endpoints []ExternalListenerEndpoint

    The list of protocol addresses the listener is configured to listen on.

    ExternalDbHomeId string

    The OCID of the external DB home.

    ExternalDbNodeId string

    The OCID of the external DB node.

    ExternalDbSystemId string

    The OCID of the external DB system that the listener is a part of.

    HostName string

    The name of the host on which the external 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 []ExternalListenerServicedAsm

    The list of ASMs that are serviced by the listener.

    ServicedDatabases []ExternalListenerServicedDatabase

    The list of databases that are serviced by the listener.

    State string

    The current lifecycle state of the external listener.

    TimeCreated string

    The date and time the external listener was created.

    TimeUpdated string

    The date and time the external listener was last updated.

    TraceDirectory string

    The destination directory of the listener trace file.

    Version string

    The listener version.

    additionalDetails Map<String,Object>

    The additional details of the external 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.

    compartmentId String

    The OCID of the compartment in which the external database resides.

    componentName String

    The name of the external listener.

    displayName String

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

    endpoints List<ExternalListenerEndpoint>

    The list of protocol addresses the listener is configured to listen on.

    externalDbHomeId String

    The OCID of the external DB home.

    externalDbNodeId String

    The OCID of the external DB node.

    externalDbSystemId String

    The OCID of the external DB system that the listener is a part of.

    hostName String

    The name of the host on which the external 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<ExternalListenerServicedAsm>

    The list of ASMs that are serviced by the listener.

    servicedDatabases List<ExternalListenerServicedDatabase>

    The list of databases that are serviced by the listener.

    state String

    The current lifecycle state of the external listener.

    timeCreated String

    The date and time the external listener was created.

    timeUpdated String

    The date and time the external listener was last updated.

    traceDirectory String

    The destination directory of the listener trace file.

    version String

    The listener version.

    additionalDetails {[key: string]: any}

    The additional details of the external 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.

    compartmentId string

    The OCID of the compartment in which the external database resides.

    componentName string

    The name of the external listener.

    displayName string

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

    endpoints ExternalListenerEndpoint[]

    The list of protocol addresses the listener is configured to listen on.

    externalDbHomeId string

    The OCID of the external DB home.

    externalDbNodeId string

    The OCID of the external DB node.

    externalDbSystemId string

    The OCID of the external DB system that the listener is a part of.

    hostName string

    The name of the host on which the external 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 ExternalListenerServicedAsm[]

    The list of ASMs that are serviced by the listener.

    servicedDatabases ExternalListenerServicedDatabase[]

    The list of databases that are serviced by the listener.

    state string

    The current lifecycle state of the external listener.

    timeCreated string

    The date and time the external listener was created.

    timeUpdated string

    The date and time the external listener was last updated.

    traceDirectory string

    The destination directory of the listener trace file.

    version string

    The listener version.

    additional_details Mapping[str, Any]

    The additional details of the external 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.

    compartment_id str

    The OCID of the compartment in which the external database resides.

    component_name str

    The name of the external listener.

    display_name str

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

    endpoints ExternalListenerEndpoint]

    The list of protocol addresses the listener is configured to listen on.

    external_db_home_id str

    The OCID of the external DB home.

    external_db_node_id str

    The OCID of the external DB node.

    external_db_system_id str

    The OCID of the external DB system that the listener is a part of.

    host_name str

    The name of the host on which the external 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 ExternalListenerServicedAsm]

    The list of ASMs that are serviced by the listener.

    serviced_databases ExternalListenerServicedDatabase]

    The list of databases that are serviced by the listener.

    state str

    The current lifecycle state of the external listener.

    time_created str

    The date and time the external listener was created.

    time_updated str

    The date and time the external listener was last updated.

    trace_directory str

    The destination directory of the listener trace file.

    version str

    The listener version.

    additionalDetails Map<Any>

    The additional details of the external 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.

    compartmentId String

    The OCID of the compartment in which the external database resides.

    componentName String

    The name of the external listener.

    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.

    externalDbHomeId String

    The OCID of the external DB home.

    externalDbNodeId String

    The OCID of the external DB node.

    externalDbSystemId String

    The OCID of the external DB system that the listener is a part of.

    hostName String

    The name of the host on which the external 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 external listener.

    timeCreated String

    The date and time the external listener was created.

    timeUpdated String

    The date and time the external listener was last updated.

    traceDirectory String

    The destination directory of the listener trace file.

    version String

    The listener version.

    Look up Existing ExternalListener Resource

    Get an existing ExternalListener 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?: ExternalListenerState, opts?: CustomResourceOptions): ExternalListener
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additional_details: Optional[Mapping[str, Any]] = None,
            adr_home_directory: Optional[str] = None,
            compartment_id: Optional[str] = None,
            component_name: Optional[str] = None,
            display_name: Optional[str] = None,
            endpoints: Optional[Sequence[_databasemanagement.ExternalListenerEndpointArgs]] = None,
            external_connector_id: Optional[str] = None,
            external_db_home_id: Optional[str] = None,
            external_db_node_id: Optional[str] = None,
            external_db_system_id: Optional[str] = None,
            external_listener_id: Optional[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[_databasemanagement.ExternalListenerServicedAsmArgs]] = None,
            serviced_databases: Optional[Sequence[_databasemanagement.ExternalListenerServicedDatabaseArgs]] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            trace_directory: Optional[str] = None,
            version: Optional[str] = None) -> ExternalListener
    func GetExternalListener(ctx *Context, name string, id IDInput, state *ExternalListenerState, opts ...ResourceOption) (*ExternalListener, error)
    public static ExternalListener Get(string name, Input<string> id, ExternalListenerState? state, CustomResourceOptions? opts = null)
    public static ExternalListener get(String name, Output<String> id, ExternalListenerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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, object>

    The additional details of the external 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.

    CompartmentId string

    The OCID of the compartment in which the external database resides.

    ComponentName string

    The name of the external listener.

    DisplayName string

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

    Endpoints List<ExternalListenerEndpoint>

    The list of protocol addresses the listener is configured to listen on.

    ExternalConnectorId string

    (Updatable) The OCID of the external connector.

    ExternalDbHomeId string

    The OCID of the external DB home.

    ExternalDbNodeId string

    The OCID of the external DB node.

    ExternalDbSystemId string

    The OCID of the external DB system that the listener is a part of.

    ExternalListenerId string

    The OCID of the external listener.

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

    The list of ASMs that are serviced by the listener.

    ServicedDatabases List<ExternalListenerServicedDatabase>

    The list of databases that are serviced by the listener.

    State string

    The current lifecycle state of the external listener.

    TimeCreated string

    The date and time the external listener was created.

    TimeUpdated string

    The date and time the external listener was last updated.

    TraceDirectory string

    The destination directory of the listener trace file.

    Version string

    The listener version.

    AdditionalDetails map[string]interface{}

    The additional details of the external 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.

    CompartmentId string

    The OCID of the compartment in which the external database resides.

    ComponentName string

    The name of the external listener.

    DisplayName string

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

    Endpoints []ExternalListenerEndpointArgs

    The list of protocol addresses the listener is configured to listen on.

    ExternalConnectorId string

    (Updatable) The OCID of the external connector.

    ExternalDbHomeId string

    The OCID of the external DB home.

    ExternalDbNodeId string

    The OCID of the external DB node.

    ExternalDbSystemId string

    The OCID of the external DB system that the listener is a part of.

    ExternalListenerId string

    The OCID of the external listener.

    ** 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 external 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 []ExternalListenerServicedAsmArgs

    The list of ASMs that are serviced by the listener.

    ServicedDatabases []ExternalListenerServicedDatabaseArgs

    The list of databases that are serviced by the listener.

    State string

    The current lifecycle state of the external listener.

    TimeCreated string

    The date and time the external listener was created.

    TimeUpdated string

    The date and time the external listener was last updated.

    TraceDirectory string

    The destination directory of the listener trace file.

    Version string

    The listener version.

    additionalDetails Map<String,Object>

    The additional details of the external 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.

    compartmentId String

    The OCID of the compartment in which the external database resides.

    componentName String

    The name of the external listener.

    displayName String

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

    endpoints List<ExternalListenerEndpoint>

    The list of protocol addresses the listener is configured to listen on.

    externalConnectorId String

    (Updatable) The OCID of the external connector.

    externalDbHomeId String

    The OCID of the external DB home.

    externalDbNodeId String

    The OCID of the external DB node.

    externalDbSystemId String

    The OCID of the external DB system that the listener is a part of.

    externalListenerId String

    The OCID of the external listener.

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

    The list of ASMs that are serviced by the listener.

    servicedDatabases List<ExternalListenerServicedDatabase>

    The list of databases that are serviced by the listener.

    state String

    The current lifecycle state of the external listener.

    timeCreated String

    The date and time the external listener was created.

    timeUpdated String

    The date and time the external listener was last updated.

    traceDirectory String

    The destination directory of the listener trace file.

    version String

    The listener version.

    additionalDetails {[key: string]: any}

    The additional details of the external 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.

    compartmentId string

    The OCID of the compartment in which the external database resides.

    componentName string

    The name of the external listener.

    displayName string

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

    endpoints ExternalListenerEndpoint[]

    The list of protocol addresses the listener is configured to listen on.

    externalConnectorId string

    (Updatable) The OCID of the external connector.

    externalDbHomeId string

    The OCID of the external DB home.

    externalDbNodeId string

    The OCID of the external DB node.

    externalDbSystemId string

    The OCID of the external DB system that the listener is a part of.

    externalListenerId string

    The OCID of the external listener.

    ** 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 external 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 ExternalListenerServicedAsm[]

    The list of ASMs that are serviced by the listener.

    servicedDatabases ExternalListenerServicedDatabase[]

    The list of databases that are serviced by the listener.

    state string

    The current lifecycle state of the external listener.

    timeCreated string

    The date and time the external listener was created.

    timeUpdated string

    The date and time the external listener was last updated.

    traceDirectory string

    The destination directory of the listener trace file.

    version string

    The listener version.

    additional_details Mapping[str, Any]

    The additional details of the external 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.

    compartment_id str

    The OCID of the compartment in which the external database resides.

    component_name str

    The name of the external listener.

    display_name str

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

    endpoints ExternalListenerEndpointArgs]

    The list of protocol addresses the listener is configured to listen on.

    external_connector_id str

    (Updatable) The OCID of the external connector.

    external_db_home_id str

    The OCID of the external DB home.

    external_db_node_id str

    The OCID of the external DB node.

    external_db_system_id str

    The OCID of the external DB system that the listener is a part of.

    external_listener_id str

    The OCID of the external listener.

    ** 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 external 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 ExternalListenerServicedAsmArgs]

    The list of ASMs that are serviced by the listener.

    serviced_databases ExternalListenerServicedDatabaseArgs]

    The list of databases that are serviced by the listener.

    state str

    The current lifecycle state of the external listener.

    time_created str

    The date and time the external listener was created.

    time_updated str

    The date and time the external listener was last updated.

    trace_directory str

    The destination directory of the listener trace file.

    version str

    The listener version.

    additionalDetails Map<Any>

    The additional details of the external 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.

    compartmentId String

    The OCID of the compartment in which the external database resides.

    componentName String

    The name of the external listener.

    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.

    externalConnectorId String

    (Updatable) The OCID of the external connector.

    externalDbHomeId String

    The OCID of the external DB home.

    externalDbNodeId String

    The OCID of the external DB node.

    externalDbSystemId String

    The OCID of the external DB system that the listener is a part of.

    externalListenerId String

    The OCID of the external listener.

    ** 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 external 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 external listener.

    timeCreated String

    The date and time the external listener was created.

    timeUpdated String

    The date and time the external listener was last updated.

    traceDirectory String

    The destination directory of the listener trace file.

    version String

    The listener version.

    Supporting Types

    ExternalListenerEndpoint, ExternalListenerEndpointArgs

    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.

    ExternalListenerServicedAsm, ExternalListenerServicedAsmArgs

    CompartmentId string

    The OCID of the compartment in which the external 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 external database.

    CompartmentId string

    The OCID of the compartment in which the external 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 external database.

    compartmentId String

    The OCID of the compartment in which the external 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 external database.

    compartmentId string

    The OCID of the compartment in which the external 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 external database.

    compartment_id str

    The OCID of the compartment in which the external 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 external database.

    compartmentId String

    The OCID of the compartment in which the external 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 external database.

    ExternalListenerServicedDatabase, ExternalListenerServicedDatabaseArgs

    CompartmentId string

    The OCID of the compartment in which the external 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 external database.

    DisplayName string

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

    Id string

    The OCID of the external database.

    IsManaged bool

    Indicates whether the database is a Managed Database or not.

    CompartmentId string

    The OCID of the compartment in which the external 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 external database.

    DisplayName string

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

    Id string

    The OCID of the external database.

    IsManaged bool

    Indicates whether the database is a Managed Database or not.

    compartmentId String

    The OCID of the compartment in which the external 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 external database.

    displayName String

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

    id String

    The OCID of the external database.

    isManaged Boolean

    Indicates whether the database is a Managed Database or not.

    compartmentId string

    The OCID of the compartment in which the external 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 external database.

    displayName string

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

    id string

    The OCID of the external database.

    isManaged boolean

    Indicates whether the database is a Managed Database or not.

    compartment_id str

    The OCID of the compartment in which the external 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 external database.

    display_name str

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

    id str

    The OCID of the external database.

    is_managed bool

    Indicates whether the database is a Managed Database or not.

    compartmentId String

    The OCID of the compartment in which the external 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 external database.

    displayName String

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

    id String

    The OCID of the external database.

    isManaged Boolean

    Indicates whether the database is a Managed Database or not.

    Import

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

     $ pulumi import oci:DatabaseManagement/externalListener:ExternalListener test_external_listener "id"
    

    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 v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi