oci.DatabaseManagement.ExternalDbSystemConnector
Explore with Pulumi AI
This resource provides the External Db System Connector resource in Oracle Cloud Infrastructure Database Management service.
Creates a new external connector.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testExternalDbSystemConnector = new oci.databasemanagement.ExternalDbSystemConnector("test_external_db_system_connector", {
connectorType: externalDbSystemConnectorConnectorType,
externalDbSystemId: testExternalDbSystem.id,
displayName: externalDbSystemConnectorDisplayName,
});
import pulumi
import pulumi_oci as oci
test_external_db_system_connector = oci.database_management.ExternalDbSystemConnector("test_external_db_system_connector",
connector_type=external_db_system_connector_connector_type,
external_db_system_id=test_external_db_system["id"],
display_name=external_db_system_connector_display_name)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/DatabaseManagement"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := DatabaseManagement.NewExternalDbSystemConnector(ctx, "test_external_db_system_connector", &DatabaseManagement.ExternalDbSystemConnectorArgs{
ConnectorType: pulumi.Any(externalDbSystemConnectorConnectorType),
ExternalDbSystemId: pulumi.Any(testExternalDbSystem.Id),
DisplayName: pulumi.Any(externalDbSystemConnectorDisplayName),
})
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 testExternalDbSystemConnector = new Oci.DatabaseManagement.ExternalDbSystemConnector("test_external_db_system_connector", new()
{
ConnectorType = externalDbSystemConnectorConnectorType,
ExternalDbSystemId = testExternalDbSystem.Id,
DisplayName = externalDbSystemConnectorDisplayName,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseManagement.ExternalDbSystemConnector;
import com.pulumi.oci.DatabaseManagement.ExternalDbSystemConnectorArgs;
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) {
var testExternalDbSystemConnector = new ExternalDbSystemConnector("testExternalDbSystemConnector", ExternalDbSystemConnectorArgs.builder()
.connectorType(externalDbSystemConnectorConnectorType)
.externalDbSystemId(testExternalDbSystem.id())
.displayName(externalDbSystemConnectorDisplayName)
.build());
}
}
resources:
testExternalDbSystemConnector:
type: oci:DatabaseManagement:ExternalDbSystemConnector
name: test_external_db_system_connector
properties:
connectorType: ${externalDbSystemConnectorConnectorType}
externalDbSystemId: ${testExternalDbSystem.id}
displayName: ${externalDbSystemConnectorDisplayName}
Create ExternalDbSystemConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ExternalDbSystemConnector(name: string, args: ExternalDbSystemConnectorArgs, opts?: CustomResourceOptions);
@overload
def ExternalDbSystemConnector(resource_name: str,
args: ExternalDbSystemConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ExternalDbSystemConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
connector_type: Optional[str] = None,
external_db_system_id: Optional[str] = None,
agent_id: Optional[str] = None,
connection_infos: Optional[Sequence[_databasemanagement.ExternalDbSystemConnectorConnectionInfoArgs]] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None)
func NewExternalDbSystemConnector(ctx *Context, name string, args ExternalDbSystemConnectorArgs, opts ...ResourceOption) (*ExternalDbSystemConnector, error)
public ExternalDbSystemConnector(string name, ExternalDbSystemConnectorArgs args, CustomResourceOptions? opts = null)
public ExternalDbSystemConnector(String name, ExternalDbSystemConnectorArgs args)
public ExternalDbSystemConnector(String name, ExternalDbSystemConnectorArgs args, CustomResourceOptions options)
type: oci:DatabaseManagement:ExternalDbSystemConnector
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 ExternalDbSystemConnectorArgs
- 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 ExternalDbSystemConnectorArgs
- 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 ExternalDbSystemConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExternalDbSystemConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ExternalDbSystemConnectorArgs
- 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 externalDbSystemConnectorResource = new Oci.DatabaseManagement.ExternalDbSystemConnector("externalDbSystemConnectorResource", new()
{
ConnectorType = "string",
ExternalDbSystemId = "string",
AgentId = "string",
ConnectionInfos = new[]
{
new Oci.DatabaseManagement.Inputs.ExternalDbSystemConnectorConnectionInfoArgs
{
ComponentType = "string",
ConnectionCredentials = new[]
{
new Oci.DatabaseManagement.Inputs.ExternalDbSystemConnectorConnectionInfoConnectionCredentialArgs
{
CredentialName = "string",
CredentialType = "string",
NamedCredentialId = "string",
PasswordSecretId = "string",
Role = "string",
SslSecretId = "string",
UserName = "string",
},
},
ConnectionStrings = new[]
{
new Oci.DatabaseManagement.Inputs.ExternalDbSystemConnectorConnectionInfoConnectionStringArgs
{
HostName = "string",
Hosts = new[]
{
"string",
},
Port = 0,
Protocol = "string",
Service = "string",
},
},
DatabaseCredentials = new[]
{
new Oci.DatabaseManagement.Inputs.ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArgs
{
CredentialType = "string",
NamedCredentialId = "string",
Password = "string",
PasswordSecretId = "string",
Role = "string",
Username = "string",
},
},
},
},
DefinedTags =
{
{ "string", "string" },
},
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
});
example, err := DatabaseManagement.NewExternalDbSystemConnector(ctx, "externalDbSystemConnectorResource", &DatabaseManagement.ExternalDbSystemConnectorArgs{
ConnectorType: pulumi.String("string"),
ExternalDbSystemId: pulumi.String("string"),
AgentId: pulumi.String("string"),
ConnectionInfos: databasemanagement.ExternalDbSystemConnectorConnectionInfoArray{
&databasemanagement.ExternalDbSystemConnectorConnectionInfoArgs{
ComponentType: pulumi.String("string"),
ConnectionCredentials: databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionCredentialArray{
&databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionCredentialArgs{
CredentialName: pulumi.String("string"),
CredentialType: pulumi.String("string"),
NamedCredentialId: pulumi.String("string"),
PasswordSecretId: pulumi.String("string"),
Role: pulumi.String("string"),
SslSecretId: pulumi.String("string"),
UserName: pulumi.String("string"),
},
},
ConnectionStrings: databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionStringArray{
&databasemanagement.ExternalDbSystemConnectorConnectionInfoConnectionStringArgs{
HostName: pulumi.String("string"),
Hosts: pulumi.StringArray{
pulumi.String("string"),
},
Port: pulumi.Int(0),
Protocol: pulumi.String("string"),
Service: pulumi.String("string"),
},
},
DatabaseCredentials: databasemanagement.ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArray{
&databasemanagement.ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArgs{
CredentialType: pulumi.String("string"),
NamedCredentialId: pulumi.String("string"),
Password: pulumi.String("string"),
PasswordSecretId: pulumi.String("string"),
Role: pulumi.String("string"),
Username: pulumi.String("string"),
},
},
},
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var externalDbSystemConnectorResource = new ExternalDbSystemConnector("externalDbSystemConnectorResource", ExternalDbSystemConnectorArgs.builder()
.connectorType("string")
.externalDbSystemId("string")
.agentId("string")
.connectionInfos(ExternalDbSystemConnectorConnectionInfoArgs.builder()
.componentType("string")
.connectionCredentials(ExternalDbSystemConnectorConnectionInfoConnectionCredentialArgs.builder()
.credentialName("string")
.credentialType("string")
.namedCredentialId("string")
.passwordSecretId("string")
.role("string")
.sslSecretId("string")
.userName("string")
.build())
.connectionStrings(ExternalDbSystemConnectorConnectionInfoConnectionStringArgs.builder()
.hostName("string")
.hosts("string")
.port(0)
.protocol("string")
.service("string")
.build())
.databaseCredentials(ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArgs.builder()
.credentialType("string")
.namedCredentialId("string")
.password("string")
.passwordSecretId("string")
.role("string")
.username("string")
.build())
.build())
.definedTags(Map.of("string", "string"))
.displayName("string")
.freeformTags(Map.of("string", "string"))
.build());
external_db_system_connector_resource = oci.database_management.ExternalDbSystemConnector("externalDbSystemConnectorResource",
connector_type="string",
external_db_system_id="string",
agent_id="string",
connection_infos=[{
"component_type": "string",
"connection_credentials": [{
"credential_name": "string",
"credential_type": "string",
"named_credential_id": "string",
"password_secret_id": "string",
"role": "string",
"ssl_secret_id": "string",
"user_name": "string",
}],
"connection_strings": [{
"host_name": "string",
"hosts": ["string"],
"port": 0,
"protocol": "string",
"service": "string",
}],
"database_credentials": [{
"credential_type": "string",
"named_credential_id": "string",
"password": "string",
"password_secret_id": "string",
"role": "string",
"username": "string",
}],
}],
defined_tags={
"string": "string",
},
display_name="string",
freeform_tags={
"string": "string",
})
const externalDbSystemConnectorResource = new oci.databasemanagement.ExternalDbSystemConnector("externalDbSystemConnectorResource", {
connectorType: "string",
externalDbSystemId: "string",
agentId: "string",
connectionInfos: [{
componentType: "string",
connectionCredentials: [{
credentialName: "string",
credentialType: "string",
namedCredentialId: "string",
passwordSecretId: "string",
role: "string",
sslSecretId: "string",
userName: "string",
}],
connectionStrings: [{
hostName: "string",
hosts: ["string"],
port: 0,
protocol: "string",
service: "string",
}],
databaseCredentials: [{
credentialType: "string",
namedCredentialId: "string",
password: "string",
passwordSecretId: "string",
role: "string",
username: "string",
}],
}],
definedTags: {
string: "string",
},
displayName: "string",
freeformTags: {
string: "string",
},
});
type: oci:DatabaseManagement:ExternalDbSystemConnector
properties:
agentId: string
connectionInfos:
- componentType: string
connectionCredentials:
- credentialName: string
credentialType: string
namedCredentialId: string
passwordSecretId: string
role: string
sslSecretId: string
userName: string
connectionStrings:
- hostName: string
hosts:
- string
port: 0
protocol: string
service: string
databaseCredentials:
- credentialType: string
namedCredentialId: string
password: string
passwordSecretId: string
role: string
username: string
connectorType: string
definedTags:
string: string
displayName: string
externalDbSystemId: string
freeformTags:
string: string
ExternalDbSystemConnector 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 ExternalDbSystemConnector resource accepts the following input properties:
- Connector
Type string - (Updatable) The type of connector.
- External
Db stringSystem Id The OCID of the external DB system.
** 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
- Agent
Id string - The OCID of the management agent used for the external DB system connector.
- Connection
Infos List<ExternalDb System Connector Connection Info> - The connection details required to connect to an external DB system component.
- Dictionary<string, string>
- 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 string - The user-friendly name for the external connector. The name does not have to be unique.
- 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"}
- Connector
Type string - (Updatable) The type of connector.
- External
Db stringSystem Id The OCID of the external DB system.
** 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
- Agent
Id string - The OCID of the management agent used for the external DB system connector.
- Connection
Infos []ExternalDb System Connector Connection Info Args - The connection details required to connect to an external DB system component.
- map[string]string
- 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 string - The user-friendly name for the external connector. The name does not have to be unique.
- 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"}
- connector
Type String - (Updatable) The type of connector.
- external
Db StringSystem Id The OCID of the external DB system.
** 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
- agent
Id String - The OCID of the management agent used for the external DB system connector.
- connection
Infos List<ExternalDb System Connector Connection Info> - The connection details required to connect to an external DB system component.
- Map<String,String>
- 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 String - The user-friendly name for the external connector. The name does not have to be unique.
- 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"}
- connector
Type string - (Updatable) The type of connector.
- external
Db stringSystem Id The OCID of the external DB system.
** 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
- agent
Id string - The OCID of the management agent used for the external DB system connector.
- connection
Infos ExternalDb System Connector Connection Info[] - The connection details required to connect to an external DB system component.
- {[key: string]: string}
- 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 string - The user-friendly name for the external connector. The name does not have to be unique.
- {[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"}
- connector_
type str - (Updatable) The type of connector.
- external_
db_ strsystem_ id The OCID of the external DB system.
** 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
- agent_
id str - The OCID of the management agent used for the external DB system connector.
- connection_
infos Sequence[databasemanagement.External Db System Connector Connection Info Args] - The connection details required to connect to an external DB system component.
- Mapping[str, str]
- 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 external connector. The name does not have to be unique.
- 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"}
- connector
Type String - (Updatable) The type of connector.
- external
Db StringSystem Id The OCID of the external DB system.
** 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
- agent
Id String - The OCID of the management agent used for the external DB system connector.
- connection
Infos List<Property Map> - The connection details required to connect to an external DB system component.
- Map<String>
- 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 String - The user-friendly name for the external connector. The name does not have to be unique.
- 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"}
Outputs
All input properties are implicitly available as output properties. Additionally, the ExternalDbSystemConnector resource produces the following output properties:
- Compartment
Id string - The OCID of the compartment.
- Connection
Failure stringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - Connection
Status string - The status of connectivity to the external DB system component.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- State string
- The current lifecycle state of the external DB system connector.
- 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"}
- Time
Connection stringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- Time
Created string - The date and time the external DB system connector was created.
- Time
Updated string - The date and time the external DB system connector was last updated.
- Compartment
Id string - The OCID of the compartment.
- Connection
Failure stringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - Connection
Status string - The status of connectivity to the external DB system component.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- State string
- The current lifecycle state of the external DB system connector.
- 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"}
- Time
Connection stringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- Time
Created string - The date and time the external DB system connector was created.
- Time
Updated string - The date and time the external DB system connector was last updated.
- compartment
Id String - The OCID of the compartment.
- connection
Failure StringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - connection
Status String - The status of connectivity to the external DB system component.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - Additional information about the current lifecycle state.
- state String
- The current lifecycle state of the external DB system connector.
- 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"}
- time
Connection StringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- time
Created String - The date and time the external DB system connector was created.
- time
Updated String - The date and time the external DB system connector was last updated.
- compartment
Id string - The OCID of the compartment.
- connection
Failure stringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - connection
Status string - The status of connectivity to the external DB system component.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details string - Additional information about the current lifecycle state.
- state string
- The current lifecycle state of the external DB system connector.
- {[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"}
- time
Connection stringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- time
Created string - The date and time the external DB system connector was created.
- time
Updated string - The date and time the external DB system connector was last updated.
- compartment_
id str - The OCID of the compartment.
- connection_
failure_ strmessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - connection_
status str - The status of connectivity to the external DB system component.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_
details str - Additional information about the current lifecycle state.
- state str
- The current lifecycle state of the external DB system connector.
- 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_
connection_ strstatus_ last_ updated - The date and time the connectionStatus of the external DB system connector was last updated.
- time_
created str - The date and time the external DB system connector was created.
- time_
updated str - The date and time the external DB system connector was last updated.
- compartment
Id String - The OCID of the compartment.
- connection
Failure StringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - connection
Status String - The status of connectivity to the external DB system component.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - Additional information about the current lifecycle state.
- state String
- The current lifecycle state of the external DB system connector.
- 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"}
- time
Connection StringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- time
Created String - The date and time the external DB system connector was created.
- time
Updated String - The date and time the external DB system connector was last updated.
Look up Existing ExternalDbSystemConnector Resource
Get an existing ExternalDbSystemConnector 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?: ExternalDbSystemConnectorState, opts?: CustomResourceOptions): ExternalDbSystemConnector
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
agent_id: Optional[str] = None,
compartment_id: Optional[str] = None,
connection_failure_message: Optional[str] = None,
connection_infos: Optional[Sequence[_databasemanagement.ExternalDbSystemConnectorConnectionInfoArgs]] = None,
connection_status: Optional[str] = None,
connector_type: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
external_db_system_id: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
lifecycle_details: Optional[str] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_connection_status_last_updated: Optional[str] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> ExternalDbSystemConnector
func GetExternalDbSystemConnector(ctx *Context, name string, id IDInput, state *ExternalDbSystemConnectorState, opts ...ResourceOption) (*ExternalDbSystemConnector, error)
public static ExternalDbSystemConnector Get(string name, Input<string> id, ExternalDbSystemConnectorState? state, CustomResourceOptions? opts = null)
public static ExternalDbSystemConnector get(String name, Output<String> id, ExternalDbSystemConnectorState 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.
- Agent
Id string - The OCID of the management agent used for the external DB system connector.
- Compartment
Id string - The OCID of the compartment.
- Connection
Failure stringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - Connection
Infos List<ExternalDb System Connector Connection Info> - The connection details required to connect to an external DB system component.
- Connection
Status string - The status of connectivity to the external DB system component.
- Connector
Type string - (Updatable) The type of connector.
- Dictionary<string, string>
- 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 string - The user-friendly name for the external connector. The name does not have to be unique.
- External
Db stringSystem Id The OCID of the external DB system.
** 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
- 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"}
- Lifecycle
Details string - Additional information about the current lifecycle state.
- State string
- The current lifecycle state of the external DB system connector.
- 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"}
- Time
Connection stringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- Time
Created string - The date and time the external DB system connector was created.
- Time
Updated string - The date and time the external DB system connector was last updated.
- Agent
Id string - The OCID of the management agent used for the external DB system connector.
- Compartment
Id string - The OCID of the compartment.
- Connection
Failure stringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - Connection
Infos []ExternalDb System Connector Connection Info Args - The connection details required to connect to an external DB system component.
- Connection
Status string - The status of connectivity to the external DB system component.
- Connector
Type string - (Updatable) The type of connector.
- map[string]string
- 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 string - The user-friendly name for the external connector. The name does not have to be unique.
- External
Db stringSystem Id The OCID of the external DB system.
** 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
- 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"}
- Lifecycle
Details string - Additional information about the current lifecycle state.
- State string
- The current lifecycle state of the external DB system connector.
- 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"}
- Time
Connection stringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- Time
Created string - The date and time the external DB system connector was created.
- Time
Updated string - The date and time the external DB system connector was last updated.
- agent
Id String - The OCID of the management agent used for the external DB system connector.
- compartment
Id String - The OCID of the compartment.
- connection
Failure StringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - connection
Infos List<ExternalDb System Connector Connection Info> - The connection details required to connect to an external DB system component.
- connection
Status String - The status of connectivity to the external DB system component.
- connector
Type String - (Updatable) The type of connector.
- Map<String,String>
- 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 String - The user-friendly name for the external connector. The name does not have to be unique.
- external
Db StringSystem Id The OCID of the external DB system.
** 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
- 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"}
- lifecycle
Details String - Additional information about the current lifecycle state.
- state String
- The current lifecycle state of the external DB system connector.
- 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"}
- time
Connection StringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- time
Created String - The date and time the external DB system connector was created.
- time
Updated String - The date and time the external DB system connector was last updated.
- agent
Id string - The OCID of the management agent used for the external DB system connector.
- compartment
Id string - The OCID of the compartment.
- connection
Failure stringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - connection
Infos ExternalDb System Connector Connection Info[] - The connection details required to connect to an external DB system component.
- connection
Status string - The status of connectivity to the external DB system component.
- connector
Type string - (Updatable) The type of connector.
- {[key: string]: string}
- 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 string - The user-friendly name for the external connector. The name does not have to be unique.
- external
Db stringSystem Id The OCID of the external DB system.
** 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
- {[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"}
- lifecycle
Details string - Additional information about the current lifecycle state.
- state string
- The current lifecycle state of the external DB system connector.
- {[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"}
- time
Connection stringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- time
Created string - The date and time the external DB system connector was created.
- time
Updated string - The date and time the external DB system connector was last updated.
- agent_
id str - The OCID of the management agent used for the external DB system connector.
- compartment_
id str - The OCID of the compartment.
- connection_
failure_ strmessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - connection_
infos Sequence[databasemanagement.External Db System Connector Connection Info Args] - The connection details required to connect to an external DB system component.
- connection_
status str - The status of connectivity to the external DB system component.
- connector_
type str - (Updatable) The type of connector.
- Mapping[str, str]
- 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 external connector. The name does not have to be unique.
- external_
db_ strsystem_ id The OCID of the external DB system.
** 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
- 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"}
- lifecycle_
details str - Additional information about the current lifecycle state.
- state str
- The current lifecycle state of the external DB system connector.
- 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_
connection_ strstatus_ last_ updated - The date and time the connectionStatus of the external DB system connector was last updated.
- time_
created str - The date and time the external DB system connector was created.
- time_
updated str - The date and time the external DB system connector was last updated.
- agent
Id String - The OCID of the management agent used for the external DB system connector.
- compartment
Id String - The OCID of the compartment.
- connection
Failure StringMessage - The error message indicating the reason for connection failure or
null
if the connection was successful. - connection
Infos List<Property Map> - The connection details required to connect to an external DB system component.
- connection
Status String - The status of connectivity to the external DB system component.
- connector
Type String - (Updatable) The type of connector.
- Map<String>
- 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 String - The user-friendly name for the external connector. The name does not have to be unique.
- external
Db StringSystem Id The OCID of the external DB system.
** 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
- 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"}
- lifecycle
Details String - Additional information about the current lifecycle state.
- state String
- The current lifecycle state of the external DB system connector.
- 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"}
- time
Connection StringStatus Last Updated - The date and time the connectionStatus of the external DB system connector was last updated.
- time
Created String - The date and time the external DB system connector was created.
- time
Updated String - The date and time the external DB system connector was last updated.
Supporting Types
ExternalDbSystemConnectorConnectionInfo, ExternalDbSystemConnectorConnectionInfoArgs
- Component
Type string - The component type.
- Connection
Credentials List<ExternalDb System Connector Connection Info Connection Credential> - The credentials used to connect to the ASM instance. Currently only the
DETAILS
type is supported for creating MACS connector credentials. - Connection
Strings List<ExternalDb System Connector Connection Info Connection String> - The Oracle Database connection string.
- Database
Credentials List<ExternalDb System Connector Connection Info Database Credential> - The credential to connect to the database to perform tablespace administration tasks.
- Component
Type string - The component type.
- Connection
Credentials []ExternalDb System Connector Connection Info Connection Credential - The credentials used to connect to the ASM instance. Currently only the
DETAILS
type is supported for creating MACS connector credentials. - Connection
Strings []ExternalDb System Connector Connection Info Connection String - The Oracle Database connection string.
- Database
Credentials []ExternalDb System Connector Connection Info Database Credential - The credential to connect to the database to perform tablespace administration tasks.
- component
Type String - The component type.
- connection
Credentials List<ExternalDb System Connector Connection Info Connection Credential> - The credentials used to connect to the ASM instance. Currently only the
DETAILS
type is supported for creating MACS connector credentials. - connection
Strings List<ExternalDb System Connector Connection Info Connection String> - The Oracle Database connection string.
- database
Credentials List<ExternalDb System Connector Connection Info Database Credential> - The credential to connect to the database to perform tablespace administration tasks.
- component
Type string - The component type.
- connection
Credentials ExternalDb System Connector Connection Info Connection Credential[] - The credentials used to connect to the ASM instance. Currently only the
DETAILS
type is supported for creating MACS connector credentials. - connection
Strings ExternalDb System Connector Connection Info Connection String[] - The Oracle Database connection string.
- database
Credentials ExternalDb System Connector Connection Info Database Credential[] - The credential to connect to the database to perform tablespace administration tasks.
- component_
type str - The component type.
- connection_
credentials Sequence[databasemanagement.External Db System Connector Connection Info Connection Credential] - The credentials used to connect to the ASM instance. Currently only the
DETAILS
type is supported for creating MACS connector credentials. - connection_
strings Sequence[databasemanagement.External Db System Connector Connection Info Connection String] - The Oracle Database connection string.
- database_
credentials Sequence[databasemanagement.External Db System Connector Connection Info Database Credential] - The credential to connect to the database to perform tablespace administration tasks.
- component
Type String - The component type.
- connection
Credentials List<Property Map> - The credentials used to connect to the ASM instance. Currently only the
DETAILS
type is supported for creating MACS connector credentials. - connection
Strings List<Property Map> - The Oracle Database connection string.
- database
Credentials List<Property Map> - The credential to connect to the database to perform tablespace administration tasks.
ExternalDbSystemConnectorConnectionInfoConnectionCredential, ExternalDbSystemConnectorConnectionInfoConnectionCredentialArgs
- Credential
Name string - The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
- Named
Credential stringId - The OCID of the named credential where the database password metadata is stored.
- Password
Secret stringId - The OCID of the Secret where the database password is stored.
- Role string
- The role of the database user.
- Ssl
Secret stringId - The OCID of the secret containing the SSL keystore and truststore details.
- User
Name string - The user name used to connect to the ASM instance.
- Credential
Name string - The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
- Named
Credential stringId - The OCID of the named credential where the database password metadata is stored.
- Password
Secret stringId - The OCID of the Secret where the database password is stored.
- Role string
- The role of the database user.
- Ssl
Secret stringId - The OCID of the secret containing the SSL keystore and truststore details.
- User
Name string - The user name used to connect to the ASM instance.
- credential
Name String - The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
- named
Credential StringId - The OCID of the named credential where the database password metadata is stored.
- password
Secret StringId - The OCID of the Secret where the database password is stored.
- role String
- The role of the database user.
- ssl
Secret StringId - The OCID of the secret containing the SSL keystore and truststore details.
- user
Name String - The user name used to connect to the ASM instance.
- credential
Name string - The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
- named
Credential stringId - The OCID of the named credential where the database password metadata is stored.
- password
Secret stringId - The OCID of the Secret where the database password is stored.
- role string
- The role of the database user.
- ssl
Secret stringId - The OCID of the secret containing the SSL keystore and truststore details.
- user
Name string - The user name used to connect to the ASM instance.
- credential_
name str - The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
- named_
credential_ strid - The OCID of the named credential where the database password metadata is stored.
- password_
secret_ strid - The OCID of the Secret where the database password is stored.
- role str
- The role of the database user.
- ssl_
secret_ strid - The OCID of the secret containing the SSL keystore and truststore details.
- user_
name str - The user name used to connect to the ASM instance.
- credential
Name String - The name of the credential information that used to connect to the DB system resource. 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 the credential for tablespace administration tasks.
- named
Credential StringId - The OCID of the named credential where the database password metadata is stored.
- password
Secret StringId - The OCID of the Secret where the database password is stored.
- role String
- The role of the database user.
- ssl
Secret StringId - The OCID of the secret containing the SSL keystore and truststore details.
- user
Name String - The user name used to connect to the ASM instance.
ExternalDbSystemConnectorConnectionInfoConnectionString, ExternalDbSystemConnectorConnectionInfoConnectionStringArgs
- Host
Name string - The host name of the database or the SCAN name in case of a RAC database.
- Hosts List<string>
- The list of host names of the ASM instances.
- Port int
- The port used to connect to the ASM instance.
- Protocol string
- The protocol used to connect to the ASM instance.
- Service string
- The service name of the ASM instance.
- Host
Name string - The host name of the database or the SCAN name in case of a RAC database.
- Hosts []string
- The list of host names of the ASM instances.
- Port int
- The port used to connect to the ASM instance.
- Protocol string
- The protocol used to connect to the ASM instance.
- Service string
- The service name of the ASM instance.
- host
Name String - The host name of the database or the SCAN name in case of a RAC database.
- hosts List<String>
- The list of host names of the ASM instances.
- port Integer
- The port used to connect to the ASM instance.
- protocol String
- The protocol used to connect to the ASM instance.
- service String
- The service name of the ASM instance.
- host
Name string - The host name of the database or the SCAN name in case of a RAC database.
- hosts string[]
- The list of host names of the ASM instances.
- port number
- The port used to connect to the ASM instance.
- protocol string
- The protocol used to connect to the ASM instance.
- service string
- The service name of the ASM instance.
- host_
name str - The host name of the database or the SCAN name in case of a RAC database.
- hosts Sequence[str]
- The list of host names of the ASM instances.
- port int
- The port used to connect to the ASM instance.
- protocol str
- The protocol used to connect to the ASM instance.
- service str
- The service name of the ASM instance.
- host
Name String - The host name of the database or the SCAN name in case of a RAC database.
- hosts List<String>
- The list of host names of the ASM instances.
- port Number
- The port used to connect to the ASM instance.
- protocol String
- The protocol used to connect to the ASM instance.
- service String
- The service name of the ASM instance.
ExternalDbSystemConnectorConnectionInfoDatabaseCredential, ExternalDbSystemConnectorConnectionInfoDatabaseCredentialArgs
- Credential
Type string - The type of the credential for tablespace administration tasks.
- Named
Credential stringId - The OCID of the named credential where the database password metadata is stored.
- Password string
- The database user's password encoded using BASE64 scheme.
- Password
Secret stringId - The OCID of the Secret where the database password is stored.
- Role string
- The role of the database user.
- Username string
- The user to connect to the database.
- Credential
Type string - The type of the credential for tablespace administration tasks.
- Named
Credential stringId - The OCID of the named credential where the database password metadata is stored.
- Password string
- The database user's password encoded using BASE64 scheme.
- Password
Secret stringId - The OCID of the Secret where the database password is stored.
- Role string
- The role of the database user.
- Username string
- The user to connect to the database.
- credential
Type String - The type of the credential for tablespace administration tasks.
- named
Credential StringId - The OCID of the named credential where the database password metadata is stored.
- password String
- The database user's password encoded using BASE64 scheme.
- password
Secret StringId - The OCID of the Secret where the database password is stored.
- role String
- The role of the database user.
- username String
- The user to connect to the database.
- credential
Type string - The type of the credential for tablespace administration tasks.
- named
Credential stringId - The OCID of the named credential where the database password metadata is stored.
- password string
- The database user's password encoded using BASE64 scheme.
- password
Secret stringId - The OCID of the Secret where the database password is stored.
- role string
- The role of the database user.
- username string
- The user to connect to the database.
- credential_
type str - The type of the credential for tablespace administration tasks.
- named_
credential_ strid - The OCID of the named credential where the database password metadata is stored.
- password str
- The database user's password encoded using BASE64 scheme.
- password_
secret_ strid - The OCID of the Secret where the database password is stored.
- role str
- The role of the database user.
- username str
- The user to connect to the database.
- credential
Type String - The type of the credential for tablespace administration tasks.
- named
Credential StringId - The OCID of the named credential where the database password metadata is stored.
- password String
- The database user's password encoded using BASE64 scheme.
- password
Secret StringId - The OCID of the Secret where the database password is stored.
- role String
- The role of the database user.
- username String
- The user to connect to the database.
Import
ExternalDbSystemConnectors can be imported using the id
, e.g.
$ pulumi import oci:DatabaseManagement/externalDbSystemConnector:ExternalDbSystemConnector test_external_db_system_connector "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.