CreateConnectionDetails

class oci.golden_gate.models.CreateConnectionDetails(**kwargs)

Bases: object

The information about a new Connection.

Attributes

CONNECTION_TYPE_AMAZON_KINESIS	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_AMAZON_REDSHIFT	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_AMAZON_S3	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_DB2	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_ELASTICSEARCH	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_GENERIC	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_GOLDENGATE	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_GOOGLE_BIGQUERY	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_HDFS	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_JAVA_MESSAGE_SERVICE	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_KAFKA	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_MICROSOFT_SQLSERVER	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_MONGODB	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_MYSQL	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_OCI_OBJECT_STORAGE	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_ORACLE	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_ORACLE_NOSQL	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_POSTGRESQL	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_REDIS	A constant which can be used with the connection_type property of a CreateConnectionDetails.
CONNECTION_TYPE_SNOWFLAKE	A constant which can be used with the connection_type property of a CreateConnectionDetails.
ROUTING_METHOD_DEDICATED_ENDPOINT	A constant which can be used with the routing_method property of a CreateConnectionDetails.
ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT	A constant which can be used with the routing_method property of a CreateConnectionDetails.
ROUTING_METHOD_SHARED_SERVICE_ENDPOINT	A constant which can be used with the routing_method property of a CreateConnectionDetails.
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.
locks	Gets the locks of this CreateConnectionDetails.
nsg_ids	Gets the nsg_ids of this CreateConnectionDetails.
routing_method	Gets the routing_method of this CreateConnectionDetails.
subnet_id	Gets the subnet_id of this CreateConnectionDetails.
vault_id	Gets the vault_id of this CreateConnectionDetails.

Methods

__init__(**kwargs)	Initializes a new CreateConnectionDetails 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'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “AMAZON_KINESIS”

CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “AMAZON_REDSHIFT”

CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “AMAZON_S3”

CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “AZURE_DATA_LAKE_STORAGE”

CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “AZURE_SYNAPSE_ANALYTICS”

CONNECTION_TYPE_DB2 = 'DB2'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “DB2”

CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “ELASTICSEARCH”

CONNECTION_TYPE_GENERIC = 'GENERIC'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “GENERIC”

CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “GOLDENGATE”

CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “GOOGLE_BIGQUERY”

CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “GOOGLE_CLOUD_STORAGE”

CONNECTION_TYPE_HDFS = 'HDFS'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “HDFS”

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “JAVA_MESSAGE_SERVICE”

CONNECTION_TYPE_KAFKA = 'KAFKA'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “KAFKA”

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “KAFKA_SCHEMA_REGISTRY”

CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “MICROSOFT_SQLSERVER”

CONNECTION_TYPE_MONGODB = 'MONGODB'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “MONGODB”

CONNECTION_TYPE_MYSQL = 'MYSQL'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “MYSQL”

CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “OCI_OBJECT_STORAGE”

CONNECTION_TYPE_ORACLE = 'ORACLE'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “ORACLE”

CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “ORACLE_NOSQL”

CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “POSTGRESQL”

CONNECTION_TYPE_REDIS = 'REDIS'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “REDIS”

CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'

A constant which can be used with the connection_type property of a CreateConnectionDetails. This constant has a value of “SNOWFLAKE”

ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'

A constant which can be used with the routing_method property of a CreateConnectionDetails. This constant has a value of “DEDICATED_ENDPOINT”

ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'

A constant which can be used with the routing_method property of a CreateConnectionDetails. This constant has a value of “SHARED_DEPLOYMENT_ENDPOINT”

ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'

A constant which can be used with the routing_method property of a CreateConnectionDetails. This constant has a value of “SHARED_SERVICE_ENDPOINT”

__init__(**kwargs)

Initializes a new CreateConnectionDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• CreatePostgresqlConnectionDetails
• CreateKafkaSchemaRegistryConnectionDetails
• CreateMicrosoftSqlserverConnectionDetails
• CreateJavaMessageServiceConnectionDetails
• CreateGoogleBigQueryConnectionDetails
• CreateAmazonKinesisConnectionDetails
• CreateSnowflakeConnectionDetails
• CreateAzureDataLakeStorageConnectionDetails
• CreateMongoDbConnectionDetails
• CreateAmazonS3ConnectionDetails
• CreateHdfsConnectionDetails
• CreateOciObjectStorageConnectionDetails
• CreateDb2ConnectionDetails
• CreateElasticsearchConnectionDetails
• CreateAzureSynapseConnectionDetails
• CreateRedisConnectionDetails
• CreateMysqlConnectionDetails
• CreateGenericConnectionDetails
• CreateGoogleCloudStorageConnectionDetails
• CreateKafkaConnectionDetails
• CreateOracleConnectionDetails
• CreateGoldenGateConnectionDetails
• CreateAmazonRedshiftConnectionDetails
• CreateOracleNosqlConnectionDetails

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 CreateConnectionDetails. 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 CreateConnectionDetails.
• description (str) – The value to assign to the description property of this CreateConnectionDetails.
• compartment_id (str) – The value to assign to the compartment_id property of this CreateConnectionDetails.
• freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateConnectionDetails.
• defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateConnectionDetails.
• locks (list[oci.golden_gate.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateConnectionDetails.
• vault_id (str) – The value to assign to the vault_id property of this CreateConnectionDetails.
• key_id (str) – The value to assign to the key_id property of this CreateConnectionDetails.
• nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateConnectionDetails.
• subnet_id (str) – The value to assign to the subnet_id property of this CreateConnectionDetails.
• routing_method (str) – The value to assign to the routing_method property of this CreateConnectionDetails. 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 CreateConnectionDetails.

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

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]

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

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

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