CreateRedisConnectionDetails¶

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

Bases: oci.golden_gate.models.create_connection_details.CreateConnectionDetails

The information about a new Redis 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`	[Required] Gets the authentication_type of this CreateRedisConnectionDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateConnectionDetails.
`connection_type`	[Required] Gets the connection_type of this CreateConnectionDetails.
`defined_tags`	Gets the defined_tags of this CreateConnectionDetails.
`description`	Gets the description of this CreateConnectionDetails.
`display_name`	[Required] Gets the display_name of this CreateConnectionDetails.
`does_use_secret_ids`	Gets the does_use_secret_ids of this CreateConnectionDetails.
`freeform_tags`	Gets the freeform_tags of this CreateConnectionDetails.
`key_id`	Gets the key_id of this CreateConnectionDetails.
`key_store`	Gets the key_store of this CreateRedisConnectionDetails.
`key_store_password`	Gets the key_store_password of this CreateRedisConnectionDetails.
`key_store_password_secret_id`	Gets the key_store_password_secret_id of this CreateRedisConnectionDetails.
`key_store_secret_id`	Gets the key_store_secret_id of this CreateRedisConnectionDetails.
`locks`	Gets the locks of this CreateConnectionDetails.
`nsg_ids`	Gets the nsg_ids of this CreateConnectionDetails.
`password`	Gets the password of this CreateRedisConnectionDetails.
`password_secret_id`	Gets the password_secret_id of this CreateRedisConnectionDetails.
`redis_cluster_id`	Gets the redis_cluster_id of this CreateRedisConnectionDetails.
`routing_method`	Gets the routing_method of this CreateConnectionDetails.
`security_protocol`	[Required] Gets the security_protocol of this CreateRedisConnectionDetails.
`servers`	Gets the servers of this CreateRedisConnectionDetails.
`subnet_id`	Gets the subnet_id of this CreateConnectionDetails.
`technology_type`	[Required] Gets the technology_type of this CreateRedisConnectionDetails.
`trust_store`	Gets the trust_store of this CreateRedisConnectionDetails.
`trust_store_password`	Gets the trust_store_password of this CreateRedisConnectionDetails.
`trust_store_password_secret_id`	Gets the trust_store_password_secret_id of this CreateRedisConnectionDetails.
`trust_store_secret_id`	Gets the trust_store_secret_id of this CreateRedisConnectionDetails.
`username`	Gets the username of this CreateRedisConnectionDetails.
`vault_id`	Gets the vault_id of this CreateConnectionDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateRedisConnectionDetails 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 CreateRedisConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is REDIS 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 CreateRedisConnectionDetails. 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 CreateRedisConnectionDetails.
description (str) – The value to assign to the description property of this CreateRedisConnectionDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateRedisConnectionDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateRedisConnectionDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateRedisConnectionDetails.
locks (list[oci.golden_gate.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateRedisConnectionDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateRedisConnectionDetails.
key_id (str) – The value to assign to the key_id property of this CreateRedisConnectionDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateRedisConnectionDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateRedisConnectionDetails.
routing_method (str) – The value to assign to the routing_method property of this CreateRedisConnectionDetails. 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 CreateRedisConnectionDetails.
technology_type (str) – The value to assign to the technology_type property of this CreateRedisConnectionDetails.
servers (str) – The value to assign to the servers property of this CreateRedisConnectionDetails.
security_protocol (str) – The value to assign to the security_protocol property of this CreateRedisConnectionDetails.
authentication_type (str) – The value to assign to the authentication_type property of this CreateRedisConnectionDetails.
username (str) – The value to assign to the username property of this CreateRedisConnectionDetails.
password (str) – The value to assign to the password property of this CreateRedisConnectionDetails.
password_secret_id (str) – The value to assign to the password_secret_id property of this CreateRedisConnectionDetails.
trust_store (str) – The value to assign to the trust_store property of this CreateRedisConnectionDetails.
trust_store_secret_id (str) – The value to assign to the trust_store_secret_id property of this CreateRedisConnectionDetails.
trust_store_password (str) – The value to assign to the trust_store_password property of this CreateRedisConnectionDetails.
trust_store_password_secret_id (str) – The value to assign to the trust_store_password_secret_id property of this CreateRedisConnectionDetails.
key_store (str) – The value to assign to the key_store property of this CreateRedisConnectionDetails.
key_store_secret_id (str) – The value to assign to the key_store_secret_id property of this CreateRedisConnectionDetails.
key_store_password (str) – The value to assign to the key_store_password property of this CreateRedisConnectionDetails.
key_store_password_secret_id (str) – The value to assign to the key_store_password_secret_id property of this CreateRedisConnectionDetails.
redis_cluster_id (str) – The value to assign to the redis_cluster_id property of this CreateRedisConnectionDetails.

authentication_type¶

[Required] Gets the authentication_type of this CreateRedisConnectionDetails. Authenticationentication type for the Redis database.

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

compartment_id¶

[Required] Gets the compartment_id of this CreateConnectionDetails. The OCID of the compartment being referenced.

Returns:	The compartment_id of this CreateConnectionDetails.
Return type:	str

connection_type¶

[Required] Gets the connection_type of this CreateConnectionDetails. 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 CreateConnectionDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateConnectionDetails. 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 CreateConnectionDetails.
Return type:	dict(str, dict(str, object))

description¶

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

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

display_name¶

[Required] Gets the display_name of this CreateConnectionDetails. An object’s Display Name.

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

does_use_secret_ids¶

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

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

freeform_tags¶

Gets the freeform_tags of this CreateConnectionDetails. 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 CreateConnectionDetails.
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 CreateConnectionDetails. 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 CreateConnectionDetails.
Return type:	str

key_store¶

Gets the key_store of this CreateRedisConnectionDetails. The base64 encoded content of the KeyStore file.

Returns:	The key_store of this CreateRedisConnectionDetails.
Return type:	str

key_store_password¶

Gets the key_store_password of this CreateRedisConnectionDetails. The KeyStore password.

Returns:	The key_store_password of this CreateRedisConnectionDetails.
Return type:	str

key_store_password_secret_id¶

Gets the key_store_password_secret_id of this CreateRedisConnectionDetails. The OCID of the Secret where the Redis KeyStore password is stored. Note: When provided, ‘keyStorePassword’ field must not be provided.

Returns:	The key_store_password_secret_id of this CreateRedisConnectionDetails.
Return type:	str

key_store_secret_id¶

Gets the key_store_secret_id of this CreateRedisConnectionDetails. The OCID of the Secret that stores the content of the KeyStore file. Note: When provided, ‘keyStore’ field must not be provided.

Returns:	The key_store_secret_id of this CreateRedisConnectionDetails.
Return type:	str

locks¶

Gets the locks of this CreateConnectionDetails. Locks associated with this resource.

Returns:	The locks of this CreateConnectionDetails.
Return type:	list[oci.golden_gate.models.AddResourceLockDetails]

nsg_ids¶

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

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

password¶

Gets the password of this CreateRedisConnectionDetails. 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.

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

password_secret_id¶

Gets the password_secret_id of this CreateRedisConnectionDetails. The OCID 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.

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

redis_cluster_id¶

Gets the redis_cluster_id of this CreateRedisConnectionDetails. The OCID of the Redis cluster.

Returns:	The redis_cluster_id of this CreateRedisConnectionDetails.
Return type:	str

routing_method¶

Gets the routing_method of this CreateConnectionDetails. 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 CreateConnectionDetails.
Return type:	str

security_protocol¶

[Required] Gets the security_protocol of this CreateRedisConnectionDetails. Security protocol for Redis.

Returns:	The security_protocol of this CreateRedisConnectionDetails.
Return type:	str

servers¶

Gets the servers of this CreateRedisConnectionDetails. 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”

Returns:	The servers of this CreateRedisConnectionDetails.
Return type:	str

subnet_id¶

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

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

technology_type¶

[Required] Gets the technology_type of this CreateRedisConnectionDetails. The Redis technology type.

Returns:	The technology_type of this CreateRedisConnectionDetails.
Return type:	str

trust_store¶

Gets the trust_store of this CreateRedisConnectionDetails. The base64 encoded content of the TrustStore file.

Returns:	The trust_store of this CreateRedisConnectionDetails.
Return type:	str

trust_store_password¶

Gets the trust_store_password of this CreateRedisConnectionDetails. The TrustStore password.

Returns:	The trust_store_password of this CreateRedisConnectionDetails.
Return type:	str

trust_store_password_secret_id¶

Gets the trust_store_password_secret_id of this CreateRedisConnectionDetails. The OCID of the Secret where the Redis TrustStore password is stored. Note: When provided, ‘trustStorePassword’ field must not be provided.

Returns:	The trust_store_password_secret_id of this CreateRedisConnectionDetails.
Return type:	str

trust_store_secret_id¶

Gets the trust_store_secret_id of this CreateRedisConnectionDetails. The OCID of the Secret that stores the content of the TrustStore file. Note: When provided, ‘trustStore’ field must not be provided.

Returns:	The trust_store_secret_id of this CreateRedisConnectionDetails.
Return type:	str

username¶

Gets the username of this CreateRedisConnectionDetails. 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.

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

vault_id¶

Gets the vault_id of this CreateConnectionDetails. 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 CreateConnectionDetails.
Return type:	str