oci.GoldenGate.getConnection
This data source provides details about a specific Connection resource in Oracle Cloud Infrastructure Golden Gate service.
Retrieves a Connection.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testConnection = Oci.GoldenGate.GetConnection.Invoke(new()
{
ConnectionId = oci_golden_gate_connection.Test_connection.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/GoldenGate"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := GoldenGate.GetConnection(ctx, &goldengate.GetConnectionArgs{
ConnectionId: oci_golden_gate_connection.Test_connection.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GoldenGate.GoldenGateFunctions;
import com.pulumi.oci.GoldenGate.inputs.GetConnectionArgs;
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 testConnection = GoldenGateFunctions.getConnection(GetConnectionArgs.builder()
.connectionId(oci_golden_gate_connection.test_connection().id())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_connection = oci.GoldenGate.get_connection(connection_id=oci_golden_gate_connection["test_connection"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testConnection = oci.GoldenGate.getConnection({
connectionId: oci_golden_gate_connection.test_connection.id,
});
variables:
testConnection:
fn::invoke:
Function: oci:GoldenGate:getConnection
Arguments:
connectionId: ${oci_golden_gate_connection.test_connection.id}
Using getConnection
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 getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
def get_connection(connection_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(connection_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
func GetConnection(ctx *Context, args *GetConnectionArgs, opts ...InvokeOption) (*GetConnectionResult, error)
func GetConnectionOutput(ctx *Context, args *GetConnectionOutputArgs, opts ...InvokeOption) GetConnectionResultOutput
> Note: This function is named GetConnection
in the Go SDK.
public static class GetConnection
{
public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:GoldenGate/getConnection:getConnection
arguments:
# arguments dictionary
The following arguments are supported:
- Connection
Id string The OCID of a Connection.
- Connection
Id string The OCID of a Connection.
- connection
Id String The OCID of a Connection.
- connection
Id string The OCID of a Connection.
- connection_
id str The OCID of a Connection.
- connection
Id String The OCID of a Connection.
getConnection Result
The following output properties are available:
- Account
Key string - Account
Name string Sets the Azure storage account name.
- Additional
Attributes List<GetConnection Additional Attribute> An array of name-value pair attribute entries. Used as additional parameters in connection string.
- Authentication
Type string Used authentication mechanism to access Azure Data Lake Storage.
- Azure
Tenant stringId Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- Bootstrap
Servers List<GetConnection Bootstrap Server> Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example:
"server1.example.com:9092,server2.example.com:9092"
- Client
Id string Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
- Client
Secret string - Compartment
Id string The OCID of the compartment being referenced.
- Connection
Id string - Connection
String string JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- Connection
Type string The connection type.
- Consumer
Properties string - Database
Id string The OCID of the database being referenced.
- Database
Name string The name of the database.
- Db
System stringId The OCID of the database system being referenced.
- Dictionary<string, object>
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Deployment
Id string The OCID of the deployment being referenced.
- Description string
Metadata about this specific object.
- Display
Name string An object's Display Name.
- Endpoint string
Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- Dictionary<string, object>
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Host string
The name or address of a host.
- Id string
The OCID of the connection being referenced.
- Ingress
Ips List<GetConnection Ingress Ip> List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
- Key
Id string The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
- Key
Store string - Key
Store stringPassword - Lifecycle
Details string Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
- Nsg
Ids List<string> An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- Password string
- Port int
The port of an endpoint usually specified for a connection.
- Private
Ip string The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- Private
Key stringFile - Private
Key stringPassphrase - Producer
Properties string - Public
Key stringFingerprint - Region string
The name of the region. e.g.: us-ashburn-1
- Sas
Token string - Security
Protocol string Security protocol for PostgreSQL.
- Session
Mode string The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
- Ssl
Ca string - Ssl
Cert string - Ssl
Crl string - Ssl
Key string - Ssl
Key stringPassword - Ssl
Mode string SSL mode for PostgreSQL.
- State string
Possible lifecycle states for connection.
- Stream
Pool stringId The OCID of the stream pool being referenced.
- Subnet
Id string The OCID of the subnet being referenced.
- Dictionary<string, object>
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example:
{orcl-cloud: {free-tier-retain: true}}
- Technology
Type string The Kafka (e.g. Confluent) Schema Registry technology type.
- Tenancy
Id string The OCID of the related Oracle Cloud Infrastructure tenancy.
- Time
Created string The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Updated string The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Trust
Store string - Trust
Store stringPassword - Url string
Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
- Username string
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
- Vault
Id string The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
- Wallet string
- Account
Key string - Account
Name string Sets the Azure storage account name.
- Additional
Attributes []GetConnection Additional Attribute An array of name-value pair attribute entries. Used as additional parameters in connection string.
- Authentication
Type string Used authentication mechanism to access Azure Data Lake Storage.
- Azure
Tenant stringId Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- Bootstrap
Servers []GetConnection Bootstrap Server Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example:
"server1.example.com:9092,server2.example.com:9092"
- Client
Id string Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
- Client
Secret string - Compartment
Id string The OCID of the compartment being referenced.
- Connection
Id string - Connection
String string JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- Connection
Type string The connection type.
- Consumer
Properties string - Database
Id string The OCID of the database being referenced.
- Database
Name string The name of the database.
- Db
System stringId The OCID of the database system being referenced.
- map[string]interface{}
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Deployment
Id string The OCID of the deployment being referenced.
- Description string
Metadata about this specific object.
- Display
Name string An object's Display Name.
- Endpoint string
Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- map[string]interface{}
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Host string
The name or address of a host.
- Id string
The OCID of the connection being referenced.
- Ingress
Ips []GetConnection Ingress Ip List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
- Key
Id string The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
- Key
Store string - Key
Store stringPassword - Lifecycle
Details string Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
- Nsg
Ids []string An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- Password string
- Port int
The port of an endpoint usually specified for a connection.
- Private
Ip string The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- Private
Key stringFile - Private
Key stringPassphrase - Producer
Properties string - Public
Key stringFingerprint - Region string
The name of the region. e.g.: us-ashburn-1
- Sas
Token string - Security
Protocol string Security protocol for PostgreSQL.
- Session
Mode string The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
- Ssl
Ca string - Ssl
Cert string - Ssl
Crl string - Ssl
Key string - Ssl
Key stringPassword - Ssl
Mode string SSL mode for PostgreSQL.
- State string
Possible lifecycle states for connection.
- Stream
Pool stringId The OCID of the stream pool being referenced.
- Subnet
Id string The OCID of the subnet being referenced.
- map[string]interface{}
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example:
{orcl-cloud: {free-tier-retain: true}}
- Technology
Type string The Kafka (e.g. Confluent) Schema Registry technology type.
- Tenancy
Id string The OCID of the related Oracle Cloud Infrastructure tenancy.
- Time
Created string The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Updated string The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Trust
Store string - Trust
Store stringPassword - Url string
Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- User
Id string The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
- Username string
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
- Vault
Id string The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
- Wallet string
- account
Key String - account
Name String Sets the Azure storage account name.
- additional
Attributes List<GetConnection Additional Attribute> An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication
Type String Used authentication mechanism to access Azure Data Lake Storage.
- azure
Tenant StringId Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- bootstrap
Servers List<GetConnection Bootstrap Server> Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example:
"server1.example.com:9092,server2.example.com:9092"
- client
Id String Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
- client
Secret String - compartment
Id String The OCID of the compartment being referenced.
- connection
Id String - connection
String String JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection
Type String The connection type.
- consumer
Properties String - database
Id String The OCID of the database being referenced.
- database
Name String The name of the database.
- db
System StringId The OCID of the database system being referenced.
- Map<String,Object>
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment
Id String The OCID of the deployment being referenced.
- description String
Metadata about this specific object.
- display
Name String An object's Display Name.
- endpoint String
Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- Map<String,Object>
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- host String
The name or address of a host.
- id String
The OCID of the connection being referenced.
- ingress
Ips List<GetConnection Ingress Ip> List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
- key
Id String The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
- key
Store String - key
Store StringPassword - lifecycle
Details String Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
- nsg
Ids List<String> An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password String
- port Integer
The port of an endpoint usually specified for a connection.
- private
Ip String The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- private
Key StringFile - private
Key StringPassphrase - producer
Properties String - public
Key StringFingerprint - region String
The name of the region. e.g.: us-ashburn-1
- sas
Token String - security
Protocol String Security protocol for PostgreSQL.
- session
Mode String The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
- ssl
Ca String - ssl
Cert String - ssl
Crl String - ssl
Key String - ssl
Key StringPassword - ssl
Mode String SSL mode for PostgreSQL.
- state String
Possible lifecycle states for connection.
- stream
Pool StringId The OCID of the stream pool being referenced.
- subnet
Id String The OCID of the subnet being referenced.
- Map<String,Object>
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example:
{orcl-cloud: {free-tier-retain: true}}
- technology
Type String The Kafka (e.g. Confluent) Schema Registry technology type.
- tenancy
Id String The OCID of the related Oracle Cloud Infrastructure tenancy.
- time
Created String The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Updated String The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- trust
Store String - trust
Store StringPassword - url String
Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
- username String
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
- vault
Id String The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
- wallet String
- account
Key string - account
Name string Sets the Azure storage account name.
- additional
Attributes GetConnection Additional Attribute[] An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication
Type string Used authentication mechanism to access Azure Data Lake Storage.
- azure
Tenant stringId Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- bootstrap
Servers GetConnection Bootstrap Server[] Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example:
"server1.example.com:9092,server2.example.com:9092"
- client
Id string Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
- client
Secret string - compartment
Id string The OCID of the compartment being referenced.
- connection
Id string - connection
String string JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection
Type string The connection type.
- consumer
Properties string - database
Id string The OCID of the database being referenced.
- database
Name string The name of the database.
- db
System stringId The OCID of the database system being referenced.
- {[key: string]: any}
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment
Id string The OCID of the deployment being referenced.
- description string
Metadata about this specific object.
- display
Name string An object's Display Name.
- endpoint string
Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- {[key: string]: any}
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- host string
The name or address of a host.
- id string
The OCID of the connection being referenced.
- ingress
Ips GetConnection Ingress Ip[] List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
- key
Id string The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
- key
Store string - key
Store stringPassword - lifecycle
Details string Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
- nsg
Ids string[] An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password string
- port number
The port of an endpoint usually specified for a connection.
- private
Ip string The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- private
Key stringFile - private
Key stringPassphrase - producer
Properties string - public
Key stringFingerprint - region string
The name of the region. e.g.: us-ashburn-1
- sas
Token string - security
Protocol string Security protocol for PostgreSQL.
- session
Mode string The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
- ssl
Ca string - ssl
Cert string - ssl
Crl string - ssl
Key string - ssl
Key stringPassword - ssl
Mode string SSL mode for PostgreSQL.
- state string
Possible lifecycle states for connection.
- stream
Pool stringId The OCID of the stream pool being referenced.
- subnet
Id string The OCID of the subnet being referenced.
- {[key: string]: any}
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example:
{orcl-cloud: {free-tier-retain: true}}
- technology
Type string The Kafka (e.g. Confluent) Schema Registry technology type.
- tenancy
Id string The OCID of the related Oracle Cloud Infrastructure tenancy.
- time
Created string The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Updated string The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- trust
Store string - trust
Store stringPassword - url string
Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id string The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
- username string
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
- vault
Id string The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
- wallet string
- account_
key str - account_
name str Sets the Azure storage account name.
- additional_
attributes GetConnection Additional Attribute] An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication_
type str Used authentication mechanism to access Azure Data Lake Storage.
- azure_
tenant_ strid Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- bootstrap_
servers GetConnection Bootstrap Server] Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example:
"server1.example.com:9092,server2.example.com:9092"
- client_
id str Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
- client_
secret str - compartment_
id str The OCID of the compartment being referenced.
- connection_
id str - connection_
string str JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection_
type str The connection type.
- consumer_
properties str - database_
id str The OCID of the database being referenced.
- database_
name str The name of the database.
- db_
system_ strid The OCID of the database system being referenced.
- Mapping[str, Any]
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment_
id str The OCID of the deployment being referenced.
- description str
Metadata about this specific object.
- display_
name str An object's Display Name.
- endpoint str
Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- Mapping[str, Any]
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- host str
The name or address of a host.
- id str
The OCID of the connection being referenced.
- ingress_
ips GetConnection Ingress Ip] List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
- key_
id str The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
- key_
store str - key_
store_ strpassword - lifecycle_
details str Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
- nsg_
ids Sequence[str] An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password str
- port int
The port of an endpoint usually specified for a connection.
- private_
ip str The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- private_
key_ strfile - private_
key_ strpassphrase - producer_
properties str - public_
key_ strfingerprint - region str
The name of the region. e.g.: us-ashburn-1
- sas_
token str - security_
protocol str Security protocol for PostgreSQL.
- session_
mode str The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
- ssl_
ca str - ssl_
cert str - ssl_
crl str - ssl_
key str - ssl_
key_ strpassword - ssl_
mode str SSL mode for PostgreSQL.
- state str
Possible lifecycle states for connection.
- stream_
pool_ strid The OCID of the stream pool being referenced.
- subnet_
id str The OCID of the subnet being referenced.
- Mapping[str, Any]
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example:
{orcl-cloud: {free-tier-retain: true}}
- technology_
type str The Kafka (e.g. Confluent) Schema Registry technology type.
- tenancy_
id str The OCID of the related Oracle Cloud Infrastructure tenancy.
- time_
created str The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time_
updated str The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- trust_
store str - trust_
store_ strpassword - url str
Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user_
id str The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
- username str
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
- vault_
id str The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
- wallet str
- account
Key String - account
Name String Sets the Azure storage account name.
- additional
Attributes List<Property Map> An array of name-value pair attribute entries. Used as additional parameters in connection string.
- authentication
Type String Used authentication mechanism to access Azure Data Lake Storage.
- azure
Tenant StringId Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f
- bootstrap
Servers List<Property Map> Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example:
"server1.example.com:9092,server2.example.com:9092"
- client
Id String Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d
- client
Secret String - compartment
Id String The OCID of the compartment being referenced.
- connection
Id String - connection
String String JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'
- connection
Type String The connection type.
- consumer
Properties String - database
Id String The OCID of the database being referenced.
- database
Name String The name of the database.
- db
System StringId The OCID of the database system being referenced.
- Map<Any>
Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment
Id String The OCID of the deployment being referenced.
- description String
Metadata about this specific object.
- display
Name String An object's Display Name.
- endpoint String
Azure Storage service endpoint. e.g: https://test.blob.core.windows.net
- Map<Any>
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- host String
The name or address of a host.
- id String
The OCID of the connection being referenced.
- ingress
Ips List<Property Map> List of ingress IP addresses, from where the GoldenGate deployment connects to this connection's privateIp.
- key
Id String The OCID of the customer "Master" key being referenced. If provided, this will reference a key which the customer will be required to ensure the policies are established to permit the GoldenGate Service to utilize this key to manage secrets.
- key
Store String - key
Store StringPassword - lifecycle
Details String Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
- nsg
Ids List<String> An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- password String
- port Number
The port of an endpoint usually specified for a connection.
- private
Ip String The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- private
Key StringFile - private
Key StringPassphrase - producer
Properties String - public
Key StringFingerprint - region String
The name of the region. e.g.: us-ashburn-1
- sas
Token String - security
Protocol String Security protocol for PostgreSQL.
- session
Mode String The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.
- ssl
Ca String - ssl
Cert String - ssl
Crl String - ssl
Key String - ssl
Key StringPassword - ssl
Mode String SSL mode for PostgreSQL.
- state String
Possible lifecycle states for connection.
- stream
Pool StringId The OCID of the stream pool being referenced.
- subnet
Id String The OCID of the subnet being referenced.
- Map<Any>
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example:
{orcl-cloud: {free-tier-retain: true}}
- technology
Type String The Kafka (e.g. Confluent) Schema Registry technology type.
- tenancy
Id String The OCID of the related Oracle Cloud Infrastructure tenancy.
- time
Created String The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Updated String The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- trust
Store String - trust
Store StringPassword - url String
Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'
- user
Id String The OCID of the Oracle Cloud Infrastructure user who will access the Object Storage. The user must have write access to the bucket they want to connect to.
- username String
The username Oracle GoldenGate uses to connect the associated RDBMS. This username must already exist and be available for use by the database. It must conform to the security requirements implemented by the database including length, case sensitivity, and so on.
- vault
Id String The OCID of the customer vault being referenced. If provided, this will reference a vault which the customer will be required to ensure the policies are established to permit the GoldenGate Service to manage secrets contained within this vault.
- wallet String
Supporting Types
GetConnectionAdditionalAttribute
GetConnectionBootstrapServer
- Host string
The name or address of a host.
- Port int
The port of an endpoint usually specified for a connection.
- Private
Ip string The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- Host string
The name or address of a host.
- Port int
The port of an endpoint usually specified for a connection.
- Private
Ip string The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- host String
The name or address of a host.
- port Integer
The port of an endpoint usually specified for a connection.
- private
Ip String The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- host string
The name or address of a host.
- port number
The port of an endpoint usually specified for a connection.
- private
Ip string The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- host str
The name or address of a host.
- port int
The port of an endpoint usually specified for a connection.
- private_
ip str The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
- host String
The name or address of a host.
- port Number
The port of an endpoint usually specified for a connection.
- private
Ip String The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
GetConnectionIngressIp
- Ingress
Ip string A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
- Ingress
Ip string A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
- ingress
Ip String A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
- ingress
Ip string A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
- ingress_
ip str A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
- ingress
Ip String A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.