Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.Database.getExternalDatabaseConnectors
Explore with Pulumi AI
This data source provides the list of External Database Connectors in Oracle Cloud Infrastructure Database service.
Gets a list of the external database connectors in the specified compartment.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testExternalDatabaseConnectors = oci.Database.getExternalDatabaseConnectors({
compartmentId: compartmentId,
externalDatabaseId: testDatabase.id,
displayName: externalDatabaseConnectorDisplayName,
state: externalDatabaseConnectorState,
});
import pulumi
import pulumi_oci as oci
test_external_database_connectors = oci.Database.get_external_database_connectors(compartment_id=compartment_id,
external_database_id=test_database["id"],
display_name=external_database_connector_display_name,
state=external_database_connector_state)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Database"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Database.GetExternalDatabaseConnectors(ctx, &database.GetExternalDatabaseConnectorsArgs{
CompartmentId: compartmentId,
ExternalDatabaseId: testDatabase.Id,
DisplayName: pulumi.StringRef(externalDatabaseConnectorDisplayName),
State: pulumi.StringRef(externalDatabaseConnectorState),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testExternalDatabaseConnectors = Oci.Database.GetExternalDatabaseConnectors.Invoke(new()
{
CompartmentId = compartmentId,
ExternalDatabaseId = testDatabase.Id,
DisplayName = externalDatabaseConnectorDisplayName,
State = externalDatabaseConnectorState,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseFunctions;
import com.pulumi.oci.Database.inputs.GetExternalDatabaseConnectorsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var testExternalDatabaseConnectors = DatabaseFunctions.getExternalDatabaseConnectors(GetExternalDatabaseConnectorsArgs.builder()
.compartmentId(compartmentId)
.externalDatabaseId(testDatabase.id())
.displayName(externalDatabaseConnectorDisplayName)
.state(externalDatabaseConnectorState)
.build());
}
}
variables:
testExternalDatabaseConnectors:
fn::invoke:
Function: oci:Database:getExternalDatabaseConnectors
Arguments:
compartmentId: ${compartmentId}
externalDatabaseId: ${testDatabase.id}
displayName: ${externalDatabaseConnectorDisplayName}
state: ${externalDatabaseConnectorState}
Using getExternalDatabaseConnectors
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getExternalDatabaseConnectors(args: GetExternalDatabaseConnectorsArgs, opts?: InvokeOptions): Promise<GetExternalDatabaseConnectorsResult>
function getExternalDatabaseConnectorsOutput(args: GetExternalDatabaseConnectorsOutputArgs, opts?: InvokeOptions): Output<GetExternalDatabaseConnectorsResult>
def get_external_database_connectors(compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
external_database_id: Optional[str] = None,
filters: Optional[Sequence[_database.GetExternalDatabaseConnectorsFilter]] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetExternalDatabaseConnectorsResult
def get_external_database_connectors_output(compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
external_database_id: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetExternalDatabaseConnectorsFilterArgs]]]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetExternalDatabaseConnectorsResult]
func GetExternalDatabaseConnectors(ctx *Context, args *GetExternalDatabaseConnectorsArgs, opts ...InvokeOption) (*GetExternalDatabaseConnectorsResult, error)
func GetExternalDatabaseConnectorsOutput(ctx *Context, args *GetExternalDatabaseConnectorsOutputArgs, opts ...InvokeOption) GetExternalDatabaseConnectorsResultOutput
> Note: This function is named GetExternalDatabaseConnectors
in the Go SDK.
public static class GetExternalDatabaseConnectors
{
public static Task<GetExternalDatabaseConnectorsResult> InvokeAsync(GetExternalDatabaseConnectorsArgs args, InvokeOptions? opts = null)
public static Output<GetExternalDatabaseConnectorsResult> Invoke(GetExternalDatabaseConnectorsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetExternalDatabaseConnectorsResult> getExternalDatabaseConnectors(GetExternalDatabaseConnectorsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Database/getExternalDatabaseConnectors:getExternalDatabaseConnectors
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id string - The compartment OCID.
- External
Database stringId - The OCID of the external database whose connectors will be listed.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
List<Get
External Database Connectors Filter> - State string
- A filter to return only resources that match the specified lifecycle state.
- Compartment
Id string - The compartment OCID.
- External
Database stringId - The OCID of the external database whose connectors will be listed.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
[]Get
External Database Connectors Filter - State string
- A filter to return only resources that match the specified lifecycle state.
- compartment
Id String - The compartment OCID.
- external
Database StringId - The OCID of the external database whose connectors will be listed.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
List<Get
External Connectors Filter> - state String
- A filter to return only resources that match the specified lifecycle state.
- compartment
Id string - The compartment OCID.
- external
Database stringId - The OCID of the external database whose connectors will be listed.
- display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
Get
External Database Connectors Filter[] - state string
- A filter to return only resources that match the specified lifecycle state.
- compartment_
id str - The compartment OCID.
- external_
database_ strid - The OCID of the external database whose connectors will be listed.
- display_
name str - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
Sequence[database.
Get External Database Connectors Filter] - state str
- A filter to return only resources that match the specified lifecycle state.
- compartment
Id String - The compartment OCID.
- external
Database StringId - The OCID of the external database whose connectors will be listed.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters List<Property Map>
- state String
- A filter to return only resources that match the specified lifecycle state.
getExternalDatabaseConnectors Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment.
- External
Database List<GetConnectors External Database Connectors External Database Connector> - The list of external_database_connectors.
- External
Database stringId - The OCID of the external database resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - The user-friendly name for the external database connector. The name does not have to be unique.
- Filters
List<Get
External Database Connectors Filter> - State string
- The current lifecycle state of the external database connector resource.
- Compartment
Id string - The OCID of the compartment.
- External
Database []GetConnectors External Database Connectors External Database Connector - The list of external_database_connectors.
- External
Database stringId - The OCID of the external database resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - The user-friendly name for the external database connector. The name does not have to be unique.
- Filters
[]Get
External Database Connectors Filter - State string
- The current lifecycle state of the external database connector resource.
- compartment
Id String - The OCID of the compartment.
- external
Database List<GetConnectors External Connectors External Connector> - The list of external_database_connectors.
- external
Database StringId - The OCID of the external database resource.
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name String - The user-friendly name for the external database connector. The name does not have to be unique.
- filters
List<Get
External Connectors Filter> - state String
- The current lifecycle state of the external database connector resource.
- compartment
Id string - The OCID of the compartment.
- external
Database GetConnectors External Database Connectors External Database Connector[] - The list of external_database_connectors.
- external
Database stringId - The OCID of the external database resource.
- id string
- The provider-assigned unique ID for this managed resource.
- display
Name string - The user-friendly name for the external database connector. The name does not have to be unique.
- filters
Get
External Database Connectors Filter[] - state string
- The current lifecycle state of the external database connector resource.
- compartment_
id str - The OCID of the compartment.
- external_
database_ Sequence[database.connectors Get External Database Connectors External Database Connector] - The list of external_database_connectors.
- external_
database_ strid - The OCID of the external database resource.
- id str
- The provider-assigned unique ID for this managed resource.
- display_
name str - The user-friendly name for the external database connector. The name does not have to be unique.
- filters
Sequence[database.
Get External Database Connectors Filter] - state str
- The current lifecycle state of the external database connector resource.
- compartment
Id String - The OCID of the compartment.
- external
Database List<Property Map>Connectors - The list of external_database_connectors.
- external
Database StringId - The OCID of the external database resource.
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name String - The user-friendly name for the external database connector. The name does not have to be unique.
- filters List<Property Map>
- state String
- The current lifecycle state of the external database connector resource.
Supporting Types
GetExternalDatabaseConnectorsExternalDatabaseConnector
- Compartment
Id string - The compartment OCID.
- Connection
Credentials List<GetExternal Database Connectors External Database Connector Connection Credential> - Credentials used to connect to the database. Currently only the
DETAILS
type is supported for creating MACS connector crendentials. - Connection
Status string - The status of connectivity to the external database.
- Connection
Strings List<GetExternal Database Connectors External Database Connector Connection String> - The Oracle Database connection string.
- Connector
Agent stringId - The ID of the agent used for the external database connector.
- Connector
Type string - The type of connector used by the external database resource.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- External
Database stringId - The OCID of the external database whose connectors will be listed.
- Dictionary<string, string>
- 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"}
- Id string
- The OCID of the external database connector.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- State string
- A filter to return only resources that match the specified lifecycle state.
- Time
Connection stringStatus Last Updated - The date and time the
connectionStatus
of this external connector was last updated. - Time
Created string - The date and time the external connector was created.
- Compartment
Id string - The compartment OCID.
- Connection
Credentials []GetExternal Database Connectors External Database Connector Connection Credential - Credentials used to connect to the database. Currently only the
DETAILS
type is supported for creating MACS connector crendentials. - Connection
Status string - The status of connectivity to the external database.
- Connection
Strings []GetExternal Database Connectors External Database Connector Connection String - The Oracle Database connection string.
- Connector
Agent stringId - The ID of the agent used for the external database connector.
- Connector
Type string - The type of connector used by the external database resource.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- External
Database stringId - The OCID of the external database whose connectors will be listed.
- map[string]string
- 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"}
- Id string
- The OCID of the external database connector.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- State string
- A filter to return only resources that match the specified lifecycle state.
- Time
Connection stringStatus Last Updated - The date and time the
connectionStatus
of this external connector was last updated. - Time
Created string - The date and time the external connector was created.
- compartment
Id String - The compartment OCID.
- connection
Credentials List<GetExternal Connectors External Connector Connection Credential> - Credentials used to connect to the database. Currently only the
DETAILS
type is supported for creating MACS connector crendentials. - connection
Status String - The status of connectivity to the external database.
- connection
Strings List<GetExternal Connectors External Connector Connection String> - The Oracle Database connection string.
- connector
Agent StringId - The ID of the agent used for the external database connector.
- connector
Type String - The type of connector used by the external database resource.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- external
Database StringId - The OCID of the external database whose connectors will be listed.
- Map<String,String>
- 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"}
- id String
- The OCID of the external database connector.
- lifecycle
Details String - Additional information about the current lifecycle state.
- state String
- A filter to return only resources that match the specified lifecycle state.
- time
Connection StringStatus Last Updated - The date and time the
connectionStatus
of this external connector was last updated. - time
Created String - The date and time the external connector was created.
- compartment
Id string - The compartment OCID.
- connection
Credentials GetExternal Database Connectors External Database Connector Connection Credential[] - Credentials used to connect to the database. Currently only the
DETAILS
type is supported for creating MACS connector crendentials. - connection
Status string - The status of connectivity to the external database.
- connection
Strings GetExternal Database Connectors External Database Connector Connection String[] - The Oracle Database connection string.
- connector
Agent stringId - The ID of the agent used for the external database connector.
- connector
Type string - The type of connector used by the external database resource.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name string - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- external
Database stringId - The OCID of the external database whose connectors will be listed.
- {[key: string]: string}
- 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"}
- id string
- The OCID of the external database connector.
- lifecycle
Details string - Additional information about the current lifecycle state.
- state string
- A filter to return only resources that match the specified lifecycle state.
- time
Connection stringStatus Last Updated - The date and time the
connectionStatus
of this external connector was last updated. - time
Created string - The date and time the external connector was created.
- compartment_
id str - The compartment OCID.
- connection_
credentials Sequence[database.Get External Database Connectors External Database Connector Connection Credential] - Credentials used to connect to the database. Currently only the
DETAILS
type is supported for creating MACS connector crendentials. - connection_
status str - The status of connectivity to the external database.
- connection_
strings Sequence[database.Get External Database Connectors External Database Connector Connection String] - The Oracle Database connection string.
- connector_
agent_ strid - The ID of the agent used for the external database connector.
- connector_
type str - The type of connector used by the external database resource.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display_
name str - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- external_
database_ strid - The OCID of the external database whose connectors will be listed.
- Mapping[str, str]
- 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"}
- id str
- The OCID of the external database connector.
- lifecycle_
details str - Additional information about the current lifecycle state.
- state str
- A filter to return only resources that match the specified lifecycle state.
- time_
connection_ strstatus_ last_ updated - The date and time the
connectionStatus
of this external connector was last updated. - time_
created str - The date and time the external connector was created.
- compartment
Id String - The compartment OCID.
- connection
Credentials List<Property Map> - Credentials used to connect to the database. Currently only the
DETAILS
type is supported for creating MACS connector crendentials. - connection
Status String - The status of connectivity to the external database.
- connection
Strings List<Property Map> - The Oracle Database connection string.
- connector
Agent StringId - The ID of the agent used for the external database connector.
- connector
Type String - The type of connector used by the external database resource.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name String - A filter to return only resources that match the entire display name given. The match is not case sensitive.
- external
Database StringId - The OCID of the external database whose connectors will be listed.
- Map<String>
- 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"}
- id String
- The OCID of the external database connector.
- lifecycle
Details String - Additional information about the current lifecycle state.
- state String
- A filter to return only resources that match the specified lifecycle state.
- time
Connection StringStatus Last Updated - The date and time the
connectionStatus
of this external connector was last updated. - time
Created String - The date and time the external connector was created.
GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionCredential
- Credential
Name string - The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- Credential
Type string - The type of credential used to connect to the database.
- Password string
- The password that will be used to connect to the database.
- Role string
- The role of the user that will be connecting to the database.
- Ssl
Secret stringId - The OCID of the Oracle Cloud Infrastructure secret.
- Username string
- The username that will be used to connect to the database.
- Credential
Name string - The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- Credential
Type string - The type of credential used to connect to the database.
- Password string
- The password that will be used to connect to the database.
- Role string
- The role of the user that will be connecting to the database.
- Ssl
Secret stringId - The OCID of the Oracle Cloud Infrastructure secret.
- Username string
- The username that will be used to connect to the database.
- credential
Name String - The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- credential
Type String - The type of credential used to connect to the database.
- password String
- The password that will be used to connect to the database.
- role String
- The role of the user that will be connecting to the database.
- ssl
Secret StringId - The OCID of the Oracle Cloud Infrastructure secret.
- username String
- The username that will be used to connect to the database.
- credential
Name string - The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- credential
Type string - The type of credential used to connect to the database.
- password string
- The password that will be used to connect to the database.
- role string
- The role of the user that will be connecting to the database.
- ssl
Secret stringId - The OCID of the Oracle Cloud Infrastructure secret.
- username string
- The username that will be used to connect to the database.
- credential_
name str - The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- credential_
type str - The type of credential used to connect to the database.
- password str
- The password that will be used to connect to the database.
- role str
- The role of the user that will be connecting to the database.
- ssl_
secret_ strid - The OCID of the Oracle Cloud Infrastructure secret.
- username str
- The username that will be used to connect to the database.
- credential
Name String - The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. IMPORTANT - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name.
- credential
Type String - The type of credential used to connect to the database.
- password String
- The password that will be used to connect to the database.
- role String
- The role of the user that will be connecting to the database.
- ssl
Secret StringId - The OCID of the Oracle Cloud Infrastructure secret.
- username String
- The username that will be used to connect to the database.
GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionString
GetExternalDatabaseConnectorsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.