goldengate.oracle.com/v1beta1 &para;

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Connection¶

Connection is the Schema for the connections API.

Plural: connections
Scope: Namespaced
APIVersion: goldengate.oracle.com/v1beta1
Sample: Sample (config/samples/goldengate_v1beta1_connection.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

ConnectionSpec defines the desired state of Connection.

Field	Description	Type	Required	Default	Enum
`accessKeyId`	Access key ID to access the Amazon Kinesis.	`string`	No	-	-
`accountKey`	Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`accountKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.	`string`	No	-	-
`accountName`	Sets the Azure storage account name.	`string`	No	-	-
`additionalAttributes`	An array of name-value pair attribute entries. Used as additional parameters in connection string.	`list[object]`	No	-	-
`authenticationMode`	Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.	`string`	No	-	-
`authenticationType`	Used authentication mechanism to access Schema Registry.	`string`	No	-	-
`azureAuthorityHost`	The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg: * Azure China: https://login.chinacloudapi.cn/ * Azure US Government: https://login.microsoftonline.us/	`string`	No	-	-
`azureTenantId`	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	`string`	No	-	-
`bootstrapServers`	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"`	`list[object]`	No	-	-
`catalog`	ConnectionCatalog defines nested fields for Connection.Catalog.	`object`	No	-	-
`clientId`	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	`string`	No	-	-
`clientSecret`	Azure client secret (aka application password) for authentication. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1 Deprecated: This field is deprecated and replaced by "clientSecretSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`clientSecretSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.	`string`	No	-	-
`clusterId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.	`string`	No	-	-
`clusterPlacementGroupId`	The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.	`string`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	Yes	-	-
`connectionFactory`	The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'	`string`	No	-	-
`connectionString`	MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'	`string`	No	-	-
`connectionType`	-	`string`	No	-	-
`connectionUrl`	Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'	`string`	No	-	-
`consumerProperties`	The base64 encoded content of the consumer.properties file.	`string`	No	-	-
`coreSiteXml`	The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`databaseId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Autonomous Json Database.	`string`	No	-	-
`databaseName`	The name of the database.	`string`	No	-	-
`dbSystemId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.	`string`	No	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`deploymentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.	`string`	No	-	-
`description`	Metadata about this specific object.	`string`	No	-	-
`displayName`	An object's Display Name.	`string`	Yes	-	-
`doesUseSecretIds`	Indicates that sensitive attributes are provided via Secrets.	`boolean`	No	-	-
`endpoint`	The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://kinesis..amazonaws.com'.	`string`	No	-	-
`fingerprint`	Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'	`string`	No	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`host`	The name or address of a host.	`string`	No	-	-
`jndiConnectionFactory`	The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'	`string`	No	-	-
`jndiInitialContextFactory`	The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'	`string`	No	-	-
`jndiProviderUrl`	The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'	`string`	No	-	-
`jndiSecurityCredentials`	The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`jndiSecurityCredentialsSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.	`string`	No	-	-
`jndiSecurityPrincipal`	Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'	`string`	No	-	-
`jsonData`	-	`string`	No	-	-
`keyId`	Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.	`string`	No	-	-
`keyStore`	The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`keyStorePassword`	The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`keyStorePasswordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.	`string`	No	-	-
`keyStoreSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file. Note: When provided, 'keyStore' field must not be provided.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`nsgIds`	An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.	`list[string]`	No	-	-
`password`	The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`passwordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.	`string`	No	-	-
`port`	The port of an endpoint usually specified for a connection.	`integer`	No	-	-
`privateIp`	Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. 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.	`string`	No	-	-
`privateKeyFile`	The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`privateKeyFileSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.	`string`	No	-	-
`privateKeyPassphrase`	The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`privateKeyPassphraseSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.	`string`	No	-	-
`producerProperties`	The base64 encoded content of the producer.properties file.	`string`	No	-	-
`publicKeyFingerprint`	The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm	`string`	No	-	-
`redisClusterId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Redis cluster.	`string`	No	-	-
`region`	The name of the AWS region. If not provided, GoldenGate will default to 'us-west-1'. Note: this property will become mandatory after July 30, 2026.	`string`	No	-	-
`routingMethod`	Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.	`string`	No	-	-
`sasToken`	Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is required when 'authenticationType' is set to 'SHARED_ACCESS_SIGNATURE'. e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D Deprecated: This field is deprecated and replaced by "sasTokenSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`sasTokenSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.	`string`	No	-	-
`secretAccessKey`	Secret access key to access the Amazon Kinesis. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`secretAccessKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the secret access key is stored. Note: When provided, 'secretAccessKey' field must not be provided.	`string`	No	-	-
`securityAttributes`	Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`	`map[string, map[string, string]]`	No	-	-
`securityProtocol`	Security protocol for PostgreSQL.	`string`	No	-	-
`servers`	Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 6379. Used for establishing the initial connection to the Redis cluster. Example: `"server1.example.com:6379,server2.example.com:6379"`	`string`	No	-	-
`serviceAccountKeyFile`	The base64 encoded content of the service account key file containing the credentials required to use Google PubSub. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`serviceAccountKeyFileSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google PubSub. Note: When provided, 'serviceAccountKeyFile' field must not be provided.	`string`	No	-	-
`sessionMode`	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.	`string`	No	-	-
`shouldUseJndi`	If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.	`boolean`	No	-	-
`shouldUseResourcePrincipal`	Specifies that the user intends to authenticate to the instance using a resource principal. Default: false	`boolean`	No	-	-
`shouldValidateServerCertificate`	If set to true, the driver validates the certificate that is sent by the database server.	`boolean`	No	-	-
`sslCa`	The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`sslCert`	The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`sslClientKeystash`	The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`sslClientKeystashSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Note: When provided, 'sslClientKeystash' field must not be provided.	`string`	No	-	-
`sslClientKeystoredb`	The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`sslClientKeystoredbSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Note: When provided, 'sslClientKeystoredb' field must not be provided.	`string`	No	-	-
`sslCrl`	The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`sslKey`	The base64 encoded private key of the PostgreSQL server. The supported file formats are .pem and .crt. Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`sslKeyPassword`	The password for the cert inside the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`sslKeyPasswordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the cert inside the KeyStore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.	`string`	No	-	-
`sslKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the private key of the PostgreSQL server. The supported file formats are .pem and .crt. Note: When provided, 'sslKey' field must not be provided.	`string`	No	-	-
`sslMode`	SSL modes for PostgreSQL.	`string`	No	-	-
`sslServerCertificate`	The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate. It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`storage`	ConnectionStorage defines nested fields for Connection.Storage.	`object`	No	-	-
`storageCredentialName`	Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.	`string`	No	-	-
`streamPoolId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream pool being referenced.	`string`	No	-	-
`subnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.	`string`	No	-	-
`subscriptionId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.	`string`	No	-	-
`technologyType`	The PostgreSQL technology type.	`string`	No	-	-
`tenancyId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.	`string`	No	-	-
`tenantId`	Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f	`string`	No	-	-
`tlsCaFile`	Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`tlsCertificateKeyFile`	Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`tlsCertificateKeyFilePassword`	Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`tlsCertificateKeyFilePasswordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.	`string`	No	-	-
`tlsCertificateKeyFileSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the certificate key file of the mtls connection. - The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.	`string`	No	-	-
`trustStore`	The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`trustStorePassword`	The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`trustStorePasswordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.	`string`	No	-	-
`trustStoreSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file. Note: When provided, 'trustStore' field must not be provided.	`string`	No	-	-
`url`	Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'	`string`	No	-	-
`userId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.	`string`	No	-	-
`username`	The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.	`string`	No	-	-
`vaultId`	Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.	`string`	No	-	-
`wallet`	The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.	`string`	No	-	-
`walletSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.	`string`	No	-	-

Spec.additionalAttributes[]¶

ConnectionAdditionalAttribute defines nested fields for Connection.AdditionalAttribute.

Field	Description	Type	Required	Default	Enum
`name`	The name of the property entry.	`string`	Yes	-	-
`value`	The value of the property entry.	`string`	Yes	-	-

Spec.bootstrapServers[]¶

ConnectionBootstrapServer defines nested fields for Connection.BootstrapServer.

Field	Description	Type	Required	Default	Enum
`host`	The name or address of a host.	`string`	Yes	-	-
`port`	The port of an endpoint usually specified for a connection.	`integer`	No	-	-
`privateIp`	Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. 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.	`string`	No	-	-

Spec.catalog¶

ConnectionCatalog defines nested fields for Connection.Catalog.

Field	Description	Type	Required	Default	Enum
`branch`	The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.	`string`	No	-	-
`catalogType`	-	`string`	No	-	-
`clientId`	The OAuth client ID used for authentication.	`string`	No	-	-
`clientSecretSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect to Snowflake platform.	`string`	No	-	-
`glueId`	The AWS Glue Catalog ID where Iceberg tables are registered.	`string`	No	-	-
`jsonData`	-	`string`	No	-	-
`name`	The catalog name within Polaris where Iceberg tables are registered.	`string`	No	-	-
`principalRole`	The Snowflake role used to access Polaris.	`string`	No	-	-
`propertiesSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm	`string`	No	-	-
`uri`	The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'	`string`	No	-	-

Spec.locks[]¶

ConnectionLock defines nested fields for Connection.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`type`	Type of the lock.	`string`	Yes	-	-

Spec.storage¶

ConnectionStorage defines nested fields for Connection.Storage.

Field	Description	Type	Required	Default	Enum
`accessKeyId`	Access key ID to access the Amazon S3 bucket.	`string`	No	-	-
`accountKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored.	`string`	No	-	-
`accountName`	Sets the Azure storage account name.	`string`	No	-	-
`bucket`	Google Cloud Storage bucket where Iceberg stores metadata and data files.	`string`	No	-	-
`container`	The Azure Blob Storage container where Iceberg tables are stored.	`string`	No	-	-
`endpoint`	The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'	`string`	No	-	-
`jsonData`	-	`string`	No	-	-
`projectId`	The Google Cloud Project where the bucket exists.	`string`	No	-	-
`region`	The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'	`string`	No	-	-
`schemeType`	The scheme of the storage.	`string`	No	-	-
`secretAccessKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored.	`string`	No	-	-
`serviceAccountKeyFileSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.	`string`	No	-	-
`storageType`	-	`string`	No	-	-

Status¶

ConnectionStatus defines the observed state of Connection.

Field	Description	Type	Required	Default	Enum
`accessKeyId`	Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"	`string`	No	-	-
`accountKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored. Note: When provided, 'accountKey' field must not be provided.	`string`	No	-	-
`accountName`	Sets the Azure storage account name.	`string`	No	-	-
`additionalAttributes`	An array of name-value pair attribute entries. Used as additional parameters in connection string.	`list[object]`	No	-	-
`authenticationMode`	Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS.	`string`	No	-	-
`authenticationType`	Authentication type for Elasticsearch.	`string`	No	-	-
`azureAuthorityHost`	The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg: * Azure China: https://login.chinacloudapi.cn/ * Azure US Government: https://login.microsoftonline.us/	`string`	No	-	-
`azureTenantId`	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	`string`	No	-	-
`bootstrapServers`	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"`	`list[object]`	No	-	-
`catalog`	ConnectionCatalog defines nested fields for Connection.Catalog.	`object`	No	-	-
`clientId`	Azure client ID of the application. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d	`string`	No	-	-
`clientSecretSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. Note: When provided, 'clientSecret' field must not be provided.	`string`	No	-	-
`clusterId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.	`string`	No	-	-
`clusterPlacementGroupId`	The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.	`string`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	No	-	-
`connectionFactory`	The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'	`string`	No	-	-
`connectionString`	MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'	`string`	No	-	-
`connectionType`	-	`string`	No	-	-
`connectionUrl`	Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'	`string`	No	-	-
`consumerProperties`	The base64 encoded content of the consumer.properties file.	`string`	No	-	-
`coreSiteXml`	The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`databaseId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Autonomous Json Database.	`string`	No	-	-
`databaseName`	The name of the database.	`string`	No	-	-
`dbSystemId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced.	`string`	No	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`deploymentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.	`string`	No	-	-
`description`	Metadata about this specific object.	`string`	No	-	-
`displayName`	An object's Display Name.	`string`	No	-	-
`doesUseSecretIds`	Indicates that sensitive attributes are provided via Secrets.	`boolean`	No	-	-
`endpoint`	The Amazon Endpoint for S3. e.g.: 'https://my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to 'https://s3..amazonaws.com'.	`string`	No	-	-
`fingerprint`	Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'	`string`	No	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`host`	The name or address of a host.	`string`	No	-	-
`id`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced.	`string`	No	-	-
`ingressIps`	List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.	`list[object]`	No	-	-
`jndiConnectionFactory`	The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'	`string`	No	-	-
`jndiInitialContextFactory`	The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'	`string`	No	-	-
`jndiProviderUrl`	The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'	`string`	No	-	-
`jndiSecurityCredentialsSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.	`string`	No	-	-
`jndiSecurityPrincipal`	Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'	`string`	No	-	-
`jsonData`	-	`string`	No	-	-
`keyId`	Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.	`string`	No	-	-
`keyStorePasswordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.	`string`	No	-	-
`keyStoreSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.	`string`	No	-	-
`lifecycleDetails`	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.	`string`	No	-	-
`lifecycleState`	Possible lifecycle states for connection.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`nsgIds`	An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.	`list[string]`	No	-	-
`passwordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.	`string`	No	-	-
`port`	The port of an endpoint usually specified for a connection.	`integer`	No	-	-
`privateIp`	Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. 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.	`string`	No	-	-
`privateKeyFileSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.	`string`	No	-	-
`privateKeyPassphraseSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.	`string`	No	-	-
`producerProperties`	The base64 encoded content of the producer.properties file.	`string`	No	-	-
`publicKeyFingerprint`	The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm	`string`	No	-	-
`redisClusterId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Redis cluster.	`string`	No	-	-
`region`	The name of the AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.	`string`	No	-	-
`routingMethod`	Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.	`string`	No	-	-
`sasTokenSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided.	`string`	No	-	-
`secretAccessKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored. Note: When provided, 'secretAccessKey' field must not be provided.	`string`	No	-	-
`securityAttributes`	Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`	`map[string, map[string, string]]`	No	-	-
`securityProtocol`	Kafka security protocol.	`string`	No	-	-
`servers`	Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example: `"server1.example.com:4000,server2.example.com:4000"`	`string`	No	-	-
`serviceAccountKeyFileSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google BigQuery. Note: When provided, 'serviceAccountKeyFile' field must not be provided.	`string`	No	-	-
`sessionMode`	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.	`string`	No	-	-
`shouldUseJndi`	If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.	`boolean`	No	-	-
`shouldUseResourcePrincipal`	Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false	`boolean`	No	-	-
`shouldValidateServerCertificate`	If set to true, the driver validates the certificate that is sent by the database server.	`boolean`	No	-	-
`sslCa`	The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`sslCert`	The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`sslClientKeystashSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Note: When provided, 'sslClientKeystash' field must not be provided.	`string`	No	-	-
`sslClientKeystoredbSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available. Note: When provided, 'sslClientKeystoredb' field must not be provided.	`string`	No	-	-
`sslCrl`	The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`sslKeyPasswordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl Key password is stored. Note: When provided, 'sslKeyPassword' field must not be provided.	`string`	No	-	-
`sslKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the private key of the PostgreSQL server. The supported file formats are .pem and .crt. Note: When provided, 'sslKey' field must not be provided.	`string`	No	-	-
`sslMode`	SSL mode for PostgreSQL.	`string`	No	-	-
`sslServerCertificate`	The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate. It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`storage`	ConnectionStorage defines nested fields for Connection.Storage.	`object`	No	-	-
`storageCredentialName`	Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.	`string`	No	-	-
`streamPoolId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream pool being referenced.	`string`	No	-	-
`subnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.	`string`	No	-	-
`subscriptionId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.	`string`	No	-	-
`systemTags`	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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`	`map[string, map[string, string]]`	No	-	-
`technologyType`	The Kafka technology type.	`string`	No	-	-
`tenancyId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.	`string`	No	-	-
`tenantId`	Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f	`string`	No	-	-
`timeCreated`	The time the resource was created. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeUpdated`	The time the resource was last updated. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`tlsCaFile`	Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the `view=COMPACT` query parameter is specified.	`string`	No	-	-
`tlsCertificateKeyFilePasswordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.	`string`	No	-	-
`tlsCertificateKeyFileSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the certificate key file of the mtls connection. - The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.	`string`	No	-	-
`trustStorePasswordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.	`string`	No	-	-
`trustStoreSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.	`string`	No	-	-
`url`	Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'	`string`	No	-	-
`userId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.	`string`	No	-	-
`username`	The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.	`string`	No	-	-
`vaultId`	Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.	`string`	No	-	-
`walletSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided.	`string`	No	-	-

Status.additionalAttributes[]¶

ConnectionAdditionalAttribute defines nested fields for Connection.AdditionalAttribute.

Field	Description	Type	Required	Default	Enum
`name`	The name of the property entry.	`string`	Yes	-	-
`value`	The value of the property entry.	`string`	Yes	-	-

Status.bootstrapServers[]¶

ConnectionBootstrapServer defines nested fields for Connection.BootstrapServer.

Field	Description	Type	Required	Default	Enum
`host`	The name or address of a host.	`string`	Yes	-	-
`port`	The port of an endpoint usually specified for a connection.	`integer`	No	-	-
`privateIp`	Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. 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.	`string`	No	-	-

Status.catalog¶

ConnectionCatalog defines nested fields for Connection.Catalog.

Field	Description	Type	Required	Default	Enum
`branch`	The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.	`string`	No	-	-
`catalogType`	-	`string`	No	-	-
`clientId`	The OAuth client ID used for authentication.	`string`	No	-	-
`clientSecretSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect to Snowflake platform.	`string`	No	-	-
`glueId`	The AWS Glue Catalog ID where Iceberg tables are registered.	`string`	No	-	-
`jsonData`	-	`string`	No	-	-
`name`	The catalog name within Polaris where Iceberg tables are registered.	`string`	No	-	-
`principalRole`	The Snowflake role used to access Polaris.	`string`	No	-	-
`propertiesSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm	`string`	No	-	-
`uri`	The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog'	`string`	No	-	-

Status.ingressIps[]¶

ConnectionIngressIp defines nested fields for Connection.IngressIp.

Field	Description	Type	Required	Default	Enum
`ingressIp`	A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.	`string`	No	-	-

Status.locks[]¶

ConnectionLock defines nested fields for Connection.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`type`	Type of the lock.	`string`	Yes	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Status.storage¶

ConnectionStorage defines nested fields for Connection.Storage.

Field	Description	Type	Required	Default	Enum
`accessKeyId`	Access key ID to access the Amazon S3 bucket.	`string`	No	-	-
`accountKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored.	`string`	No	-	-
`accountName`	Sets the Azure storage account name.	`string`	No	-	-
`bucket`	Google Cloud Storage bucket where Iceberg stores metadata and data files.	`string`	No	-	-
`container`	The Azure Blob Storage container where Iceberg tables are stored.	`string`	No	-	-
`endpoint`	The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net'	`string`	No	-	-
`jsonData`	-	`string`	No	-	-
`projectId`	The Google Cloud Project where the bucket exists.	`string`	No	-	-
`region`	The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'	`string`	No	-	-
`schemeType`	The scheme of the storage.	`string`	No	-	-
`secretAccessKeySecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored.	`string`	No	-	-
`serviceAccountKeyFileSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage.	`string`	No	-	-
`storageType`	-	`string`	No	-	-

ConnectionAssignment¶

ConnectionAssignment is the Schema for the connectionassignments API.

Plural: connectionassignments
Scope: Namespaced
APIVersion: goldengate.oracle.com/v1beta1
Sample: Sample (config/samples/goldengate_v1beta1_connectionassignment.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

ConnectionAssignmentSpec defines the desired state of ConnectionAssignment.

Field	Description	Type	Required	Default	Enum
`connectionId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced.	`string`	Yes	-	-
`deploymentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.	`string`	Yes	-	-

Status¶

ConnectionAssignmentStatus defines the observed state of ConnectionAssignment.

Field	Description	Type	Required	Default	Enum
`aliasName`	Credential store alias.	`string`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	No	-	-
`connectionId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced.	`string`	No	-	-
`deploymentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.	`string`	No	-	-
`id`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection assignment being referenced.	`string`	No	-	-
`lifecycleState`	Possible lifecycle states for connection assignments.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`timeCreated`	The time the resource was created. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeUpdated`	The time the resource was last updated. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

DatabaseRegistration¶

DatabaseRegistration is the Schema for the databaseregistrations API.

Plural: databaseregistrations
Scope: Namespaced
APIVersion: goldengate.oracle.com/v1beta1
Sample: Sample (config/samples/goldengate_v1beta1_databaseregistration.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

DatabaseRegistrationSpec defines the desired state of DatabaseRegistration.

Field	Description	Type	Required	Default	Enum
`aliasName`	Credential store alias.	`string`	Yes	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	Yes	-	-
`connectionString`	Connect descriptor or Easy Connect Naming method used to connect to a database.	`string`	No	-	-
`databaseId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced.	`string`	No	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`description`	Metadata about this specific object.	`string`	No	-	-
`displayName`	An object's Display Name.	`string`	Yes	-	-
`fqdn`	A three-label Fully Qualified Domain Name (FQDN) for a resource.	`string`	Yes	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`ipAddress`	The private IP address in the customer's VCN of the customer's endpoint, typically a database.	`string`	No	-	-
`keyId`	Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.	`string`	No	-	-
`password`	The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.	`string`	Yes	-	-
`secretCompartmentId`	The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.	`string`	No	-	-
`sessionMode`	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.	`string`	No	-	-
`subnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.	`string`	No	-	-
`username`	The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.	`string`	Yes	-	-
`vaultId`	Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.	`string`	No	-	-
`wallet`	The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded. Deprecated: This field is deprecated and replaced by "walletSecretId". This field will be removed after February 15 2026.	`string`	No	-	-

Status¶

DatabaseRegistrationStatus defines the observed state of DatabaseRegistration.

Field	Description	Type	Required	Default	Enum
`aliasName`	Credential store alias.	`string`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	No	-	-
`connectionString`	Connect descriptor or Easy Connect Naming method used to connect to a database.	`string`	No	-	-
`databaseId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced.	`string`	No	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`description`	Metadata about this specific object.	`string`	No	-	-
`displayName`	An object's Display Name.	`string`	No	-	-
`fqdn`	A three-label Fully Qualified Domain Name (FQDN) for a resource.	`string`	No	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the databaseRegistration being referenced.	`string`	No	-	-
`ipAddress`	The private IP address in the customer's VCN of the customer's endpoint, typically a database.	`string`	No	-	-
`keyId`	Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.	`string`	No	-	-
`lifecycleDetails`	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.	`string`	No	-	-
`lifecycleState`	Possible lifecycle states.	`string`	No	-	-
`rcePrivateIp`	A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.	`string`	No	-	-
`secretCompartmentId`	The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.	`string`	No	-	-
`secretId`	The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret.	`string`	No	-	-
`sessionMode`	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.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`subnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.	`string`	No	-	-
`systemTags`	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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`	`map[string, map[string, string]]`	No	-	-
`timeCreated`	The time the resource was created. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeUpdated`	The time the resource was last updated. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`username`	The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.	`string`	No	-	-
`vaultId`	Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Deployment¶

Deployment is the Schema for the deployments API.

Plural: deployments
Scope: Namespaced
APIVersion: goldengate.oracle.com/v1beta1
Sample: Sample (config/samples/goldengate_v1beta1_deployment.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

DeploymentSpec defines the desired state of Deployment.

Field	Description	Type	Required	Default	Enum
`availabilityDomain`	The availability domain of a placement.	`string`	No	-	-
`backupSchedule`	DeploymentBackupSchedule defines nested fields for Deployment.BackupSchedule.	`object`	No	-	-
`byolCpuCoreCountLimit`	The maximum number of CPUs allowed with a 'Bring Your Own License' (BYOL) license type. Any CPU usage above this limit is considered as License Included and billed.	`integer`	No	-	-
`clusterPlacementGroupId`	The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.	`string`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	Yes	-	-
`cpuCoreCount`	The Minimum number of OCPUs to be made available for this Deployment.	`integer`	No	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`deploymentBackupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced.	`string`	No	-	-
`deploymentType`	The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.	`string`	No	-	-
`description`	Metadata about this specific object.	`string`	No	-	-
`displayName`	An object's Display Name.	`string`	Yes	-	-
`environmentType`	Specifies whether the deployment is used in a production or development/testing environment.	`string`	No	-	-
`faultDomain`	The fault domain of a placement.	`string`	No	-	-
`fqdn`	A three-label Fully Qualified Domain Name (FQDN) for a resource.	`string`	No	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`isAutoScalingEnabled`	Indicates if auto scaling is enabled for the Deployment's CPU core count.	`boolean`	No	-	-
`isByolCpuCoreCountLimitEnabled`	Flag to allow to configure the 'Bring Your Own License' (BYOL) license type CPU limit. If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.	`boolean`	No	-	-
`isPublic`	True if this object is publicly available.	`boolean`	No	-	-
`licenseModel`	The Oracle license model that applies to a Deployment.	`string`	No	-	-
`loadBalancerSubnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`maintenanceConfiguration`	DeploymentMaintenanceConfiguration defines nested fields for Deployment.MaintenanceConfiguration.	`object`	No	-	-
`maintenanceWindow`	DeploymentMaintenanceWindow defines nested fields for Deployment.MaintenanceWindow.	`object`	No	-	-
`nsgIds`	An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.	`list[string]`	No	-	-
`oggData`	DeploymentOggData defines nested fields for Deployment.OggData.	`object`	No	-	-
`placements`	An array of local peers of deployment	`list[object]`	No	-	-
`securityAttributes`	Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`	`map[string, map[string, string]]`	No	-	-
`sourceDeploymentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.	`string`	No	-	-
`subnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.	`string`	Yes	-	-
`subscriptionId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.	`string`	No	-	-

Spec.backupSchedule¶

DeploymentBackupSchedule defines nested fields for Deployment.BackupSchedule.

Field	Description	Type	Required	Default	Enum
`bucketName`	Name of the bucket where the object is to be uploaded in the object storage	`string`	Yes	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	Yes	-	-
`frequencyBackupScheduled`	The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.	`string`	Yes	-	-
`isMetadataOnly`	Parameter to allow users to create backup without trails	`boolean`	Yes	-	-
`namespaceName`	Name of namespace that serves as a container for all of your buckets	`string`	Yes	-	-
`timeBackupScheduled`	The start timestamp for the deployment backup schedule. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.	`string`	Yes	-	-

Spec.locks[]¶

DeploymentLock defines nested fields for Deployment.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`type`	Type of the lock.	`string`	Yes	-	-

Spec.maintenanceConfiguration¶

DeploymentMaintenanceConfiguration defines nested fields for Deployment.MaintenanceConfiguration.

Field	Description	Type	Required	Default	Enum
`bundleReleaseUpgradePeriodInDays`	Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.	`integer`	No	-	-
`interimReleaseUpgradePeriodInDays`	Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.	`integer`	No	-	-
`isInterimReleaseAutoUpgradeEnabled`	By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.	`boolean`	No	-	-
`majorReleaseUpgradePeriodInDays`	Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default.	`integer`	No	-	-
`securityPatchUpgradePeriodInDays`	Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default.	`integer`	No	-	-

Spec.maintenanceWindow¶

DeploymentMaintenanceWindow defines nested fields for Deployment.MaintenanceWindow.

Field	Description	Type	Required	Default	Enum
`day`	Days of the week.	`string`	Yes	-	-
`startHour`	Start hour for maintenance period. Hour is in UTC.	`integer`	Yes	-	-

Spec.oggData¶

DeploymentOggData defines nested fields for Deployment.OggData.

Field	Description	Type	Required	Default	Enum
`adminPassword`	The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as '$', '^', or '?' are not allowed. This field will be deprecated and replaced by "passwordSecretId".	`string`	No	-	-
`adminUsername`	The GoldenGate deployment console username.	`string`	No	-	-
`certificate`	The base64 encoded content of the PEM file containing the SSL certificate.	`string`	No	-	-
`credentialStore`	The type of credential store for OGG.	`string`	No	-	-
`deploymentName`	The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.	`string`	Yes	-	-
`groupToRolesMapping`	DeploymentOggDataGroupToRolesMapping defines nested fields for Deployment.OggData.GroupToRolesMapping.	`object`	No	-	-
`identityDomainId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used.	`string`	No	-	-
`key`	The base64 encoded content of the PEM file containing the private key.	`string`	No	-	-
`oggVersion`	Version of OGG	`string`	No	-	-
`passwordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored.	`string`	No	-	-

Spec.oggData.groupToRolesMapping¶

DeploymentOggDataGroupToRolesMapping defines nested fields for Deployment.OggData.GroupToRolesMapping.

Field	Description	Type	Required	Default	Enum
`administratorGroupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.	`string`	No	-	-
`operatorGroupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.	`string`	No	-	-
`securityGroupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.	`string`	Yes	-	-
`userGroupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information	`string`	No	-	-

Spec.placements[]¶

DeploymentPlacement defines nested fields for Deployment.Placement.

Field	Description	Type	Required	Default	Enum
`availabilityDomain`	The availability domain of a placement.	`string`	No	-	-
`faultDomain`	The fault domain of a placement.	`string`	No	-	-

Status¶

DeploymentStatus defines the observed state of Deployment.

Field	Description	Type	Required	Default	Enum
`availabilityDomain`	The availability domain of a placement.	`string`	No	-	-
`backupSchedule`	DeploymentBackupSchedule defines nested fields for Deployment.BackupSchedule.	`object`	No	-	-
`byolCpuCoreCountLimit`	The maximum number of CPUs allowed with a 'Bring Your Own License' (BYOL) license type. Any CPU usage above this limit is considered as License Included and billed.	`integer`	No	-	-
`category`	The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.	`string`	No	-	-
`clusterPlacementGroupId`	The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.	`string`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	No	-	-
`cpuCoreCount`	The Minimum number of OCPUs to be made available for this Deployment.	`integer`	No	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`deploymentBackupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced.	`string`	No	-	-
`deploymentDiagnosticData`	DeploymentDiagnosticData defines nested fields for Deployment.DeploymentDiagnosticData.	`object`	No	-	-
`deploymentRole`	The type of the deployment role.	`string`	No	-	-
`deploymentType`	The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.	`string`	No	-	-
`deploymentUrl`	The URL of a resource.	`string`	No	-	-
`description`	Metadata about this specific object.	`string`	No	-	-
`displayName`	An object's Display Name.	`string`	No	-	-
`environmentType`	Specifies whether the deployment is used in a production or development/testing environment.	`string`	No	-	-
`faultDomain`	The fault domain of a placement.	`string`	No	-	-
`fqdn`	A three-label Fully Qualified Domain Name (FQDN) for a resource.	`string`	No	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.	`string`	No	-	-
`ingressIps`	List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.	`list[object]`	No	-	-
`isAutoScalingEnabled`	Indicates if auto scaling is enabled for the Deployment's CPU core count.	`boolean`	No	-	-
`isByolCpuCoreCountLimitEnabled`	Flag to allow to configure the 'Bring Your Own License' (BYOL) license type CPU limit. If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.	`boolean`	No	-	-
`isHealthy`	True if all of the aggregate resources are working correctly.	`boolean`	No	-	-
`isLatestVersion`	Indicates if the resource is the the latest available version.	`boolean`	No	-	-
`isPublic`	True if this object is publicly available.	`boolean`	No	-	-
`isStorageUtilizationLimitExceeded`	Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=. Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit. Exceeding the limit may be an indication of a misconfiguration of the deployment's GoldenGate service.	`boolean`	No	-	-
`licenseModel`	The Oracle license model that applies to a Deployment.	`string`	No	-	-
`lifecycleDetails`	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.	`string`	No	-	-
`lifecycleState`	Possible lifecycle states.	`string`	No	-	-
`lifecycleSubState`	Possible GGS lifecycle sub-states.	`string`	No	-	-
`loadBalancerId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.	`string`	No	-	-
`loadBalancerSubnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`maintenanceConfiguration`	DeploymentMaintenanceConfiguration defines nested fields for Deployment.MaintenanceConfiguration.	`object`	No	-	-
`maintenanceWindow`	DeploymentMaintenanceWindow defines nested fields for Deployment.MaintenanceWindow.	`object`	No	-	-
`nextMaintenanceActionType`	Type of the next maintenance.	`string`	No	-	-
`nextMaintenanceDescription`	Description of the next maintenance.	`string`	No	-	-
`nsgIds`	An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.	`list[string]`	No	-	-
`oggData`	DeploymentOggData defines nested fields for Deployment.OggData.	`object`	No	-	-
`placements`	An array of local peers of deployment	`list[object]`	No	-	-
`privateIpAddress`	The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.	`string`	No	-	-
`publicIpAddress`	The public IP address representing the access point for the Deployment.	`string`	No	-	-
`securityAttributes`	Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`	`map[string, map[string, string]]`	No	-	-
`sourceDeploymentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.	`string`	No	-	-
`status`	-	`object`	Yes	-	-
`storageUtilizationInBytes`	The amount of storage being utilized (in bytes)	`integer (int64)`	No	-	-
`subnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.	`string`	No	-	-
`subscriptionId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.	`string`	No	-	-
`systemTags`	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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`	`map[string, map[string, string]]`	No	-	-
`timeCreated`	The time the resource was created. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeLastBackupScheduled`	The timestamp of last deployment backup scheduled. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.	`string`	No	-	-
`timeNextBackupScheduled`	The timestamp of next deployment backup scheduled. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`.	`string`	No	-	-
`timeOfNextMaintenance`	The time of next maintenance schedule. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeOggVersionSupportedUntil`	The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeRoleChanged`	The time of the last role change. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeUpdated`	The time the resource was last updated. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeUpgradeRequired`	Note: Deprecated: Use timeOfNextMaintenance instead, or related upgrade records to check, when deployment will be forced to upgrade to a newer version. Old description: The date the existing version in use will no longer be considered as usable and an upgrade will be required. This date is typically 6 months after the version was released for use by GGS. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-

Status.backupSchedule¶

DeploymentBackupSchedule defines nested fields for Deployment.BackupSchedule.

Field	Description	Type	Required	Default	Enum
`bucketName`	Name of the bucket where the object is to be uploaded in the object storage	`string`	Yes	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	Yes	-	-
`frequencyBackupScheduled`	The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.	`string`	Yes	-	-
`isMetadataOnly`	Parameter to allow users to create backup without trails	`boolean`	Yes	-	-
`namespaceName`	Name of namespace that serves as a container for all of your buckets	`string`	Yes	-	-
`timeBackupScheduled`	The start timestamp for the deployment backup schedule. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.	`string`	Yes	-	-

Status.deploymentDiagnosticData¶

DeploymentDiagnosticData defines nested fields for Deployment.DeploymentDiagnosticData.

Field	Description	Type	Required	Default	Enum
`bucketName`	Name of the bucket where the object is to be uploaded in the object storage	`string`	No	-	-
`diagnosticState`	The state of the deployment diagnostic collection.	`string`	No	-	-
`namespaceName`	Name of namespace that serves as a container for all of your buckets	`string`	No	-	-
`objectName`	Name of the diagnostic collected and uploaded to object storage	`string`	No	-	-
`timeDiagnosticEnd`	The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeDiagnosticStart`	The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-

Status.ingressIps[]¶

DeploymentIngressIp defines nested fields for Deployment.IngressIp.

Field	Description	Type	Required	Default	Enum
`ingressIp`	A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.	`string`	No	-	-

Status.locks[]¶

DeploymentLock defines nested fields for Deployment.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`type`	Type of the lock.	`string`	Yes	-	-

Status.maintenanceConfiguration¶

DeploymentMaintenanceConfiguration defines nested fields for Deployment.MaintenanceConfiguration.

Field	Description	Type	Required	Default	Enum
`bundleReleaseUpgradePeriodInDays`	Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.	`integer`	No	-	-
`interimReleaseUpgradePeriodInDays`	Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.	`integer`	No	-	-
`isInterimReleaseAutoUpgradeEnabled`	By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.	`boolean`	No	-	-
`majorReleaseUpgradePeriodInDays`	Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default.	`integer`	No	-	-
`securityPatchUpgradePeriodInDays`	Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default.	`integer`	No	-	-

Status.maintenanceWindow¶

DeploymentMaintenanceWindow defines nested fields for Deployment.MaintenanceWindow.

Field	Description	Type	Required	Default	Enum
`day`	Days of the week.	`string`	Yes	-	-
`startHour`	Start hour for maintenance period. Hour is in UTC.	`integer`	Yes	-	-

Status.oggData¶

DeploymentOggData defines nested fields for Deployment.OggData.

Field	Description	Type	Required	Default	Enum
`adminPassword`	The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as '$', '^', or '?' are not allowed. This field will be deprecated and replaced by "passwordSecretId".	`string`	No	-	-
`adminUsername`	The GoldenGate deployment console username.	`string`	No	-	-
`certificate`	The base64 encoded content of the PEM file containing the SSL certificate.	`string`	No	-	-
`credentialStore`	The type of credential store for OGG.	`string`	No	-	-
`deploymentName`	The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.	`string`	Yes	-	-
`groupToRolesMapping`	DeploymentOggDataGroupToRolesMapping defines nested fields for Deployment.OggData.GroupToRolesMapping.	`object`	No	-	-
`identityDomainId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used.	`string`	No	-	-
`key`	The base64 encoded content of the PEM file containing the private key.	`string`	No	-	-
`oggVersion`	Version of OGG	`string`	No	-	-
`passwordSecretId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored.	`string`	No	-	-

Status.oggData.groupToRolesMapping¶

DeploymentOggDataGroupToRolesMapping defines nested fields for Deployment.OggData.GroupToRolesMapping.

Field	Description	Type	Required	Default	Enum
`administratorGroupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.	`string`	No	-	-
`operatorGroupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.	`string`	No	-	-
`securityGroupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.	`string`	Yes	-	-
`userGroupId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information	`string`	No	-	-

Status.placements[]¶

DeploymentPlacement defines nested fields for Deployment.Placement.

Field	Description	Type	Required	Default	Enum
`availabilityDomain`	The availability domain of a placement.	`string`	No	-	-
`faultDomain`	The fault domain of a placement.	`string`	No	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Back to DeploymentBackup spec

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

DeploymentBackup¶

DeploymentBackup is the Schema for the deploymentbackups API.

Plural: deploymentbackups
Scope: Namespaced
APIVersion: goldengate.oracle.com/v1beta1
Sample: Sample (config/samples/goldengate_v1beta1_deploymentbackup.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

DeploymentBackupSpec defines the desired state of DeploymentBackup.

Field	Description	Type	Required	Default	Enum
`bucketName`	Name of the bucket where the object is to be uploaded in the object storage	`string`	Yes	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	Yes	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`deploymentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.	`string`	Yes	-	-
`displayName`	An object's Display Name.	`string`	Yes	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`isMetadataOnly`	Parameter to allow users to create backup without trails	`boolean`	No	-	-
`jsonData`	-	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`namespaceName`	Name of namespace that serves as a container for all of your buckets	`string`	Yes	-	-
`objectName`	Name of the object to be uploaded to object storage	`string`	Yes	-	-
`type`	-	`string`	No	-	-

Spec.locks[]¶

DeploymentBackupLock defines nested fields for DeploymentBackup.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`type`	Type of the lock.	`string`	Yes	-	-

Status¶

DeploymentBackupStatus defines the observed state of DeploymentBackup.

Field	Description	Type	Required	Default	Enum
`backupSourceType`	Possible deployment backup source types.	`string`	No	-	-
`backupType`	Possible Deployment backup types.	`string`	No	-	-
`bucketName`	Name of the bucket where the object is to be uploaded in the object storage	`string`	No	-	-
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	No	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`deploymentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.	`string`	No	-	-
`deploymentType`	The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.	`string`	No	-	-
`displayName`	An object's Display Name.	`string`	No	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced.	`string`	No	-	-
`isAutomatic`	True if this object is automatically created	`boolean`	No	-	-
`isMetadataOnly`	Parameter to allow users to create backup without trails	`boolean`	No	-	-
`lifecycleDetails`	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.	`string`	No	-	-
`lifecycleState`	Possible lifecycle states.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`namespaceName`	Name of namespace that serves as a container for all of your buckets	`string`	No	-	-
`objectName`	Name of the object to be uploaded to object storage	`string`	No	-	-
`oggVersion`	Version of OGG	`string`	No	-	-
`sizeInBytes`	The size of the backup stored in object storage (in bytes)	`integer (int64)`	No	-	-
`status`	-	`object`	Yes	-	-
`systemTags`	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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`	`map[string, map[string, string]]`	No	-	-
`timeBackupFinished`	The time of the resource backup finish. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeCreated`	The time the resource was created. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeOfBackup`	The time of the resource backup. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeUpdated`	The time the resource was last updated. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-

Status.locks[]¶

DeploymentBackupLock defines nested fields for DeploymentBackup.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`type`	Type of the lock.	`string`	Yes	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Pipeline¶

Pipeline is the Schema for the pipelines API.

Plural: pipelines
Scope: Namespaced
APIVersion: goldengate.oracle.com/v1beta1
Sample: Sample (config/samples/goldengate_v1beta1_pipeline.yaml)
Packages: Not currently exposed by a customer-visible package.

Spec¶

PipelineSpec defines the desired state of Pipeline.

Field	Description	Type	Required	Default	Enum
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	Yes	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`description`	Metadata about this specific object.	`string`	No	-	-
`displayName`	An object's Display Name.	`string`	Yes	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`jsonData`	-	`string`	No	-	-
`licenseModel`	The Oracle license model that applies to a Deployment.	`string`	Yes	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`mappingRules`	Mapping for source/target schema/tables for the pipeline data replication.	`list[object]`	No	-	-
`processOptions`	PipelineProcessOptions defines nested fields for Pipeline.ProcessOptions.	`object`	No	-	-
`recipeType`	-	`string`	No	-	-
`sourceConnectionDetails`	PipelineSourceConnectionDetails defines nested fields for Pipeline.SourceConnectionDetails.	`object`	Yes	-	-
`subnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the pipeline's private endpoint. The subnet must be a private subnet.	`string`	No	-	-
`targetConnectionDetails`	PipelineTargetConnectionDetails defines nested fields for Pipeline.TargetConnectionDetails.	`object`	Yes	-	-

Spec.locks[]¶

PipelineLock defines nested fields for Pipeline.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`relatedResourceId`	The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.	`string`	No	-	-
`timeCreated`	When the lock was created.	`string`	No	-	-
`type`	Type of the lock.	`string`	Yes	-	-

Spec.mappingRules[]¶

PipelineMappingRule defines nested fields for Pipeline.MappingRule.

Field	Description	Type	Required	Default	Enum
`mappingType`	Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.	`string`	Yes	-	-
`source`	The source schema/table combination for replication to target.	`string`	Yes	-	-
`target`	The target schema/table combination for replication from the source.	`string`	No	-	-

Spec.processOptions¶

PipelineProcessOptions defines nested fields for Pipeline.ProcessOptions.

Field	Description	Type	Required	Default	Enum
`initialDataLoad`	PipelineProcessOptionsInitialDataLoad defines nested fields for Pipeline.ProcessOptions.InitialDataLoad.	`object`	Yes	-	-
`replicateSchemaChange`	PipelineProcessOptionsReplicateSchemaChange defines nested fields for Pipeline.ProcessOptions.ReplicateSchemaChange.	`object`	Yes	-	-
`shouldRestartOnFailure`	If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.	`string`	Yes	-	-
`startUsingDefaultMapping`	If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option only applies when creating a pipeline and is not applicable while updating a pipeline.	`string`	No	-	-

Spec.processOptions.initialDataLoad¶

PipelineProcessOptionsInitialDataLoad defines nested fields for Pipeline.ProcessOptions.InitialDataLoad.

Field	Description	Type	Required	Default	Enum
`actionOnExistingTable`	Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.	`string`	No	-	-
`isInitialLoad`	If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.	`string`	Yes	-	-

Spec.processOptions.replicateSchemaChange¶

PipelineProcessOptionsReplicateSchemaChange defines nested fields for Pipeline.ProcessOptions.ReplicateSchemaChange.

Field	Description	Type	Required	Default	Enum
`actionOnDdlError`	Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true	`string`	No	-	-
`actionOnDmlError`	Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true	`string`	No	-	-
`canReplicateSchemaChange`	If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline.	`string`	Yes	-	-

Spec.sourceConnectionDetails¶

PipelineSourceConnectionDetails defines nested fields for Pipeline.SourceConnectionDetails.

Field	Description	Type	Required	Default	Enum
`connectionId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced.	`string`	Yes	-	-

Spec.targetConnectionDetails¶

PipelineTargetConnectionDetails defines nested fields for Pipeline.TargetConnectionDetails.

Field	Description	Type	Required	Default	Enum
`connectionId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced.	`string`	Yes	-	-

Status¶

PipelineStatus defines the observed state of Pipeline.

Field	Description	Type	Required	Default	Enum
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.	`string`	No	-	-
`cpuCoreCount`	The Minimum number of OCPUs to be made available for this Deployment.	`integer`	No	-	-
`definedTags`	Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`description`	Metadata about this specific object.	`string`	No	-	-
`displayName`	An object's Display Name.	`string`	No	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline.	`string`	No	-	-
`ingressIps`	List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.	`list[object]`	No	-	-
`isAutoScalingEnabled`	Indicates if auto scaling is enabled for the Deployment's CPU core count.	`boolean`	No	-	-
`jsonData`	-	`string`	No	-	-
`licenseModel`	The Oracle license model that applies to a Deployment.	`string`	No	-	-
`lifecycleDetails`	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.	`string`	No	-	-
`lifecycleState`	Lifecycle state of the pipeline.	`string`	No	-	-
`lifecycleSubState`	Possible lifecycle substates when retrieving a pipeline.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`mappingRules`	Mapping for source/target schema/tables for the pipeline data replication.	`list[object]`	No	-	-
`pipelineDiagnosticData`	PipelineDiagnosticData defines nested fields for Pipeline.PipelineDiagnosticData.	`object`	No	-	-
`processOptions`	PipelineProcessOptions defines nested fields for Pipeline.ProcessOptions.	`object`	No	-	-
`recipeType`	-	`string`	No	-	-
`sourceConnectionDetails`	PipelineSourceConnectionDetails defines nested fields for Pipeline.SourceConnectionDetails.	`object`	No	-	-
`status`	-	`object`	Yes	-	-
`subnetId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the pipeline's private endpoint. The subnet must be a private subnet.	`string`	No	-	-
`systemTags`	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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`	`map[string, map[string, string]]`	No	-	-
`targetConnectionDetails`	PipelineTargetConnectionDetails defines nested fields for Pipeline.TargetConnectionDetails.	`object`	No	-	-
`timeCreated`	The time the resource was created. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-
`timeLastRecorded`	When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.	`string`	No	-	-
`timeUpdated`	The time the resource was last updated. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.	`string`	No	-	-

Status.ingressIps[]¶

PipelineIngressIp defines nested fields for Pipeline.IngressIp.

Field	Description	Type	Required	Default	Enum
`ingressIp`	A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.	`string`	No	-	-

Status.locks[]¶

PipelineLock defines nested fields for Pipeline.Lock.

Field	Description	Type	Required	Default	Enum
`message`	A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.	`string`	No	-	-
`relatedResourceId`	The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.	`string`	No	-	-
`timeCreated`	When the lock was created.	`string`	No	-	-
`type`	Type of the lock.	`string`	Yes	-	-

Status.mappingRules[]¶

PipelineMappingRule defines nested fields for Pipeline.MappingRule.

Field	Description	Type	Required	Default	Enum
`mappingType`	Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.	`string`	Yes	-	-
`source`	The source schema/table combination for replication to target.	`string`	Yes	-	-
`target`	The target schema/table combination for replication from the source.	`string`	No	-	-

Status.pipelineDiagnosticData¶

PipelineDiagnosticData defines nested fields for Pipeline.PipelineDiagnosticData.

Field	Description	Type	Required	Default	Enum
`bucketName`	Name of the bucket where the object is to be uploaded in the object storage	`string`	No	-	-
`diagnosticState`	The state of the pipeline diagnostics collection.	`string`	No	-	-
`namespaceName`	Name of namespace that serves as a container for all of your buckets	`string`	No	-	-
`objectName`	Name of the diagnostic collected and uploaded to object storage	`string`	No	-	-
`timeLastCollected`	The date and time the diagnostic data was last collected for the pipeline. The format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.	`string`	No	-	-

Status.processOptions¶

PipelineProcessOptions defines nested fields for Pipeline.ProcessOptions.

Field	Description	Type	Required	Default	Enum
`initialDataLoad`	PipelineProcessOptionsInitialDataLoad defines nested fields for Pipeline.ProcessOptions.InitialDataLoad.	`object`	Yes	-	-
`replicateSchemaChange`	PipelineProcessOptionsReplicateSchemaChange defines nested fields for Pipeline.ProcessOptions.ReplicateSchemaChange.	`object`	Yes	-	-
`shouldRestartOnFailure`	If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline.	`string`	Yes	-	-
`startUsingDefaultMapping`	If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option only applies when creating a pipeline and is not applicable while updating a pipeline.	`string`	No	-	-

Status.processOptions.initialDataLoad¶

PipelineProcessOptionsInitialDataLoad defines nested fields for Pipeline.ProcessOptions.InitialDataLoad.

Field	Description	Type	Required	Default	Enum
`actionOnExistingTable`	Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.	`string`	No	-	-
`isInitialLoad`	If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline.	`string`	Yes	-	-

Status.processOptions.replicateSchemaChange¶

PipelineProcessOptionsReplicateSchemaChange defines nested fields for Pipeline.ProcessOptions.ReplicateSchemaChange.

Field	Description	Type	Required	Default	Enum
`actionOnDdlError`	Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true	`string`	No	-	-
`actionOnDmlError`	Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true	`string`	No	-	-
`canReplicateSchemaChange`	If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline.	`string`	Yes	-	-

Status.sourceConnectionDetails¶

PipelineSourceConnectionDetails defines nested fields for Pipeline.SourceConnectionDetails.

Field	Description	Type	Required	Default	Enum
`connectionId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced.	`string`	Yes	-	-

Status.status¶

Field	Description	Type	Required	Default	Enum
`async`	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	`object`	No	-	-
`conditions`	-	`list[object]`	No	-	-
`createdAt`	-	`string (date-time)`	No	-	-
`deletedAt`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`ocid`	-	`string`	No	-	-
`opcRequestId`	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	`string`	No	-	-
`reason`	-	`string`	No	-	-
`requestedAt`	-	`string (date-time)`	No	-	-
`updatedAt`	-	`string (date-time)`	No	-	-

Status.status.async¶

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
`current`	-	`object`	No	-	-

Status.status.async.current¶

Field	Description	Type	Required	Default	Enum
`message`	-	`string`	No	-	-
`normalizedClass`	-	`string`	Yes	-	`attention`, `canceled`, `failed`, `pending`, `succeeded`, `unknown`
`percentComplete`	-	`number`	No	-	-
`phase`	-	`string`	Yes	-	`create`, `delete`, `update`
`rawOperationType`	-	`string`	No	-	-
`rawStatus`	-	`string`	No	-	-
`source`	-	`string`	Yes	-	`lifecycle`, `none`, `workrequest`
`updatedAt`	-	`string (date-time)`	Yes	-	-
`workRequestId`	-	`string`	No	-	-

Status.status.conditions[]¶

Field	Description	Type	Required	Default	Enum
`lastTransitionTime`	-	`string (date-time)`	No	-	-
`message`	-	`string`	No	-	-
`reason`	-	`string`	No	-	-
`status`	-	`string`	Yes	-	-
`type`	-	`string`	Yes	-	-

Status.targetConnectionDetails¶