UpdateSnowflakeConnectionDetails¶

class oci.golden_gate.models.UpdateSnowflakeConnectionDetails(**kwargs)¶

Bases: oci.golden_gate.models.update_connection_details.UpdateConnectionDetails

The information to update a Snowflake Connection.

Attributes

`CONNECTION_TYPE_AMAZON_KINESIS`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_REDSHIFT`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_S3`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS`	str(object=’’) -> str
`CONNECTION_TYPE_DB2`	str(object=’’) -> str
`CONNECTION_TYPE_ELASTICSEARCH`	str(object=’’) -> str
`CONNECTION_TYPE_GENERIC`	str(object=’’) -> str
`CONNECTION_TYPE_GOLDENGATE`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_BIGQUERY`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_HDFS`	str(object=’’) -> str
`CONNECTION_TYPE_JAVA_MESSAGE_SERVICE`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY`	str(object=’’) -> str
`CONNECTION_TYPE_MICROSOFT_SQLSERVER`	str(object=’’) -> str
`CONNECTION_TYPE_MONGODB`	str(object=’’) -> str
`CONNECTION_TYPE_MYSQL`	str(object=’’) -> str
`CONNECTION_TYPE_OCI_OBJECT_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE_NOSQL`	str(object=’’) -> str
`CONNECTION_TYPE_POSTGRESQL`	str(object=’’) -> str
`CONNECTION_TYPE_REDIS`	str(object=’’) -> str
`CONNECTION_TYPE_SNOWFLAKE`	str(object=’’) -> str
`ROUTING_METHOD_DEDICATED_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_SERVICE_ENDPOINT`	str(object=’’) -> str
`authentication_type`	Gets the authentication_type of this UpdateSnowflakeConnectionDetails.
`connection_type`	Gets the connection_type of this UpdateConnectionDetails.
`connection_url`	Gets the connection_url of this UpdateSnowflakeConnectionDetails.
`defined_tags`	Gets the defined_tags of this UpdateConnectionDetails.
`description`	Gets the description of this UpdateConnectionDetails.
`display_name`	Gets the display_name of this UpdateConnectionDetails.
`does_use_secret_ids`	Gets the does_use_secret_ids of this UpdateConnectionDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateConnectionDetails.
`key_id`	Gets the key_id of this UpdateConnectionDetails.
`nsg_ids`	Gets the nsg_ids of this UpdateConnectionDetails.
`password`	Gets the password of this UpdateSnowflakeConnectionDetails.
`password_secret_id`	Gets the password_secret_id of this UpdateSnowflakeConnectionDetails.
`private_key_file`	Gets the private_key_file of this UpdateSnowflakeConnectionDetails.
`private_key_file_secret_id`	Gets the private_key_file_secret_id of this UpdateSnowflakeConnectionDetails.
`private_key_passphrase`	Gets the private_key_passphrase of this UpdateSnowflakeConnectionDetails.
`private_key_passphrase_secret_id`	Gets the private_key_passphrase_secret_id of this UpdateSnowflakeConnectionDetails.
`routing_method`	Gets the routing_method of this UpdateConnectionDetails.
`subnet_id`	Gets the subnet_id of this UpdateConnectionDetails.
`username`	Gets the username of this UpdateSnowflakeConnectionDetails.
`vault_id`	Gets the vault_id of this UpdateConnectionDetails.

Methods

`__init__`(**kwargs)	Initializes a new UpdateSnowflakeConnectionDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'¶

CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'¶

CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'¶

CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'¶

CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'¶

CONNECTION_TYPE_DB2 = 'DB2'¶

CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'¶

CONNECTION_TYPE_GENERIC = 'GENERIC'¶

CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'¶

CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'¶

CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'¶

CONNECTION_TYPE_HDFS = 'HDFS'¶

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'¶

CONNECTION_TYPE_KAFKA = 'KAFKA'¶

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'¶

CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'¶

CONNECTION_TYPE_MONGODB = 'MONGODB'¶

CONNECTION_TYPE_MYSQL = 'MYSQL'¶

CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'¶

CONNECTION_TYPE_ORACLE = 'ORACLE'¶

CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'¶

CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'¶

CONNECTION_TYPE_REDIS = 'REDIS'¶

CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'¶

ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'¶

ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'¶

ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'¶

__init__(**kwargs)¶

Initializes a new UpdateSnowflakeConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is SNOWFLAKE and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

connection_type (str) – The value to assign to the connection_type property of this UpdateSnowflakeConnectionDetails. Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”
display_name (str) – The value to assign to the display_name property of this UpdateSnowflakeConnectionDetails.
description (str) – The value to assign to the description property of this UpdateSnowflakeConnectionDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateSnowflakeConnectionDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateSnowflakeConnectionDetails.
vault_id (str) – The value to assign to the vault_id property of this UpdateSnowflakeConnectionDetails.
key_id (str) – The value to assign to the key_id property of this UpdateSnowflakeConnectionDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this UpdateSnowflakeConnectionDetails.
subnet_id (str) – The value to assign to the subnet_id property of this UpdateSnowflakeConnectionDetails.
routing_method (str) – The value to assign to the routing_method property of this UpdateSnowflakeConnectionDetails. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”
does_use_secret_ids (bool) – The value to assign to the does_use_secret_ids property of this UpdateSnowflakeConnectionDetails.
connection_url (str) – The value to assign to the connection_url property of this UpdateSnowflakeConnectionDetails.
authentication_type (str) – The value to assign to the authentication_type property of this UpdateSnowflakeConnectionDetails.
username (str) – The value to assign to the username property of this UpdateSnowflakeConnectionDetails.
password (str) – The value to assign to the password property of this UpdateSnowflakeConnectionDetails.
password_secret_id (str) – The value to assign to the password_secret_id property of this UpdateSnowflakeConnectionDetails.
private_key_file (str) – The value to assign to the private_key_file property of this UpdateSnowflakeConnectionDetails.
private_key_file_secret_id (str) – The value to assign to the private_key_file_secret_id property of this UpdateSnowflakeConnectionDetails.
private_key_passphrase (str) – The value to assign to the private_key_passphrase property of this UpdateSnowflakeConnectionDetails.
private_key_passphrase_secret_id (str) – The value to assign to the private_key_passphrase_secret_id property of this UpdateSnowflakeConnectionDetails.

authentication_type¶

Gets the authentication_type of this UpdateSnowflakeConnectionDetails. Used authentication mechanism to access Snowflake.

Returns:	The authentication_type of this UpdateSnowflakeConnectionDetails.
Return type:	str

connection_type¶

Gets the connection_type of this UpdateConnectionDetails. The connection type.

Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”

Returns:	The connection_type of this UpdateConnectionDetails.
Return type:	str

connection_url¶

Gets the connection_url of this UpdateSnowflakeConnectionDetails. JDBC connection URL. e.g.: ‘jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>’

Returns:	The connection_url of this UpdateSnowflakeConnectionDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this UpdateConnectionDetails. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this UpdateConnectionDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this UpdateConnectionDetails. Metadata about this specific object.

Returns:	The description of this UpdateConnectionDetails.
Return type:	str

display_name¶

Gets the display_name of this UpdateConnectionDetails. An object’s Display Name.

Returns:	The display_name of this UpdateConnectionDetails.
Return type:	str

does_use_secret_ids¶

Gets the does_use_secret_ids of this UpdateConnectionDetails. Indicates that sensitive attributes are provided via Secrets.

Returns:	The does_use_secret_ids of this UpdateConnectionDetails.
Return type:	bool

freeform_tags¶

Gets the freeform_tags of this UpdateConnectionDetails. A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this UpdateConnectionDetails.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

key_id¶

Gets the key_id of this UpdateConnectionDetails. 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.

Returns:	The key_id of this UpdateConnectionDetails.
Return type:	str

nsg_ids¶

Gets the nsg_ids of this UpdateConnectionDetails. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns:	The nsg_ids of this UpdateConnectionDetails.
Return type:	list[str]

password¶

Gets the password of this UpdateSnowflakeConnectionDetails. The password Oracle GoldenGate uses to connect to Snowflake platform.

Returns:	The password of this UpdateSnowflakeConnectionDetails.
Return type:	str

password_secret_id¶

Gets the password_secret_id of this UpdateSnowflakeConnectionDetails. The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Snowflake platform. Note: When provided, ‘password’ field must not be provided.

Returns:	The password_secret_id of this UpdateSnowflakeConnectionDetails.
Return type:	str

private_key_file¶

Gets the private_key_file of this UpdateSnowflakeConnectionDetails. The base64 encoded content of private key file in PEM format.

Returns:	The private_key_file of this UpdateSnowflakeConnectionDetails.
Return type:	str

private_key_file_secret_id¶

Gets the private_key_file_secret_id of this UpdateSnowflakeConnectionDetails. The OCID 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.

Returns:	The private_key_file_secret_id of this UpdateSnowflakeConnectionDetails.
Return type:	str

private_key_passphrase¶

Gets the private_key_passphrase of this UpdateSnowflakeConnectionDetails. Password if the private key file is encrypted.

Returns:	The private_key_passphrase of this UpdateSnowflakeConnectionDetails.
Return type:	str

private_key_passphrase_secret_id¶

Gets the private_key_passphrase_secret_id of this UpdateSnowflakeConnectionDetails. The OCID of the Secret that stores the password for the private key file. Note: When provided, ‘privateKeyPassphrase’ field must not be provided.

Returns:	The private_key_passphrase_secret_id of this UpdateSnowflakeConnectionDetails.
Return type:	str

routing_method¶

Gets the routing_method of this UpdateConnectionDetails. 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.

Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”

Returns:	The routing_method of this UpdateConnectionDetails.
Return type:	str

subnet_id¶

Gets the subnet_id of this UpdateConnectionDetails. The OCID of the target subnet of the dedicated connection.

Returns:	The subnet_id of this UpdateConnectionDetails.
Return type:	str

username¶

Gets the username of this UpdateSnowflakeConnectionDetails. The username Oracle GoldenGate uses to connect to Snowflake. This username must already exist and be available by Snowflake platform to be connected to.

Returns:	The username of this UpdateSnowflakeConnectionDetails.
Return type:	str

vault_id¶

Gets the vault_id of this UpdateConnectionDetails. 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.

Returns:	The vault_id of this UpdateConnectionDetails.
Return type:	str