CreateSparkConnectionDetails¶

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

Bases: oci.golden_gate.models.create_connection_details.CreateConnectionDetails

The information about a new Spark Connection.

Attributes

`CONNECTION_TYPE_AI_MODEL`	str(object=’’) -> str
`CONNECTION_TYPE_AI_PROVIDER`	str(object=’’) -> str
`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_DATABRICKS`	str(object=’’) -> str
`CONNECTION_TYPE_DATABRICKS_ENGINE`	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_GOOGLE_PUBSUB`	str(object=’’) -> str
`CONNECTION_TYPE_HDFS`	str(object=’’) -> str
`CONNECTION_TYPE_ICEBERG`	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_FABRIC`	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_AI_DATA_PLATFORM`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM_ENGINE`	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
`CONNECTION_TYPE_SPARK`	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
`artifact_location`	[Required] Gets the artifact_location of this CreateSparkConnectionDetails.
`auth_secret`	Gets the auth_secret of this CreateSparkConnectionDetails.
`auth_secret_secret_id`	Gets the auth_secret_secret_id of this CreateSparkConnectionDetails.
`authentication_type`	[Required] Gets the authentication_type of this CreateSparkConnectionDetails.
`cluster_endpoint`	[Required] Gets the cluster_endpoint of this CreateSparkConnectionDetails.
`cluster_placement_group_id`	Gets the cluster_placement_group_id of this 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.
`key_store`	Gets the key_store of this CreateSparkConnectionDetails.
`key_store_password`	Gets the key_store_password of this CreateSparkConnectionDetails.
`key_store_password_secret_id`	Gets the key_store_password_secret_id of this CreateSparkConnectionDetails.
`key_store_secret_id`	Gets the key_store_secret_id of this CreateSparkConnectionDetails.
`key_store_type`	Gets the key_store_type of this CreateSparkConnectionDetails.
`locks`	Gets the locks of this CreateConnectionDetails.
`nsg_ids`	Gets the nsg_ids of this CreateConnectionDetails.
`rest_auth_secret_key`	Gets the rest_auth_secret_key of this CreateSparkConnectionDetails.
`rest_auth_secret_key_secret_id`	Gets the rest_auth_secret_key_secret_id of this CreateSparkConnectionDetails.
`rest_endpoint`	Gets the rest_endpoint of this CreateSparkConnectionDetails.
`routing_method`	Gets the routing_method of this CreateConnectionDetails.
`rpc_cipher`	Gets the rpc_cipher of this CreateSparkConnectionDetails.
`security_attributes`	Gets the security_attributes of this CreateConnectionDetails.
`security_protocol`	[Required] Gets the security_protocol of this CreateSparkConnectionDetails.
`ssl_key_password`	Gets the ssl_key_password of this CreateSparkConnectionDetails.
`ssl_key_password_secret_id`	Gets the ssl_key_password_secret_id of this CreateSparkConnectionDetails.
`submit_mode`	[Required] Gets the submit_mode of this CreateSparkConnectionDetails.
`subnet_id`	Gets the subnet_id of this CreateConnectionDetails.
`subscription_id`	Gets the subscription_id of this CreateConnectionDetails.
`technology_type`	[Required] Gets the technology_type of this CreateSparkConnectionDetails.
`tls_protocol`	Gets the tls_protocol of this CreateSparkConnectionDetails.
`trust_store`	Gets the trust_store of this CreateSparkConnectionDetails.
`trust_store_password`	Gets the trust_store_password of this CreateSparkConnectionDetails.
`trust_store_password_secret_id`	Gets the trust_store_password_secret_id of this CreateSparkConnectionDetails.
`trust_store_secret_id`	Gets the trust_store_secret_id of this CreateSparkConnectionDetails.
`trust_store_type`	Gets the trust_store_type of this CreateSparkConnectionDetails.
`vault_id`	Gets the vault_id of this CreateConnectionDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateSparkConnectionDetails 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_AI_MODEL = 'AI_MODEL'¶

CONNECTION_TYPE_AI_PROVIDER = 'AI_PROVIDER'¶

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_DATABRICKS = 'DATABRICKS'¶

CONNECTION_TYPE_DATABRICKS_ENGINE = 'DATABRICKS_ENGINE'¶

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_GOOGLE_PUBSUB = 'GOOGLE_PUBSUB'¶

CONNECTION_TYPE_HDFS = 'HDFS'¶

CONNECTION_TYPE_ICEBERG = 'ICEBERG'¶

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'¶

CONNECTION_TYPE_KAFKA = 'KAFKA'¶

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'¶

CONNECTION_TYPE_MICROSOFT_FABRIC = 'MICROSOFT_FABRIC'¶

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_AI_DATA_PLATFORM = 'ORACLE_AI_DATA_PLATFORM'¶

CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM_ENGINE = 'ORACLE_AI_DATA_PLATFORM_ENGINE'¶

CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'¶

CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'¶

CONNECTION_TYPE_REDIS = 'REDIS'¶

CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'¶

CONNECTION_TYPE_SPARK = 'SPARK'¶

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 CreateSparkConnectionDetails object with values from keyword arguments. The default value of the connection_type attribute of this class is SPARK 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 CreateSparkConnectionDetails. 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_AI_DATA_PLATFORM”, “ORACLE_AI_DATA_PLATFORM_ENGINE”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “DATABRICKS_ENGINE”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “SPARK”, “ICEBERG”, “AI_PROVIDER”, “AI_MODEL”
display_name (str) – The value to assign to the display_name property of this CreateSparkConnectionDetails.
description (str) – The value to assign to the description property of this CreateSparkConnectionDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateSparkConnectionDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSparkConnectionDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSparkConnectionDetails.
locks (list[oci.golden_gate.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateSparkConnectionDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateSparkConnectionDetails.
key_id (str) – The value to assign to the key_id property of this CreateSparkConnectionDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateSparkConnectionDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateSparkConnectionDetails.
routing_method (str) – The value to assign to the routing_method property of this CreateSparkConnectionDetails. 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 CreateSparkConnectionDetails.
subscription_id (str) – The value to assign to the subscription_id property of this CreateSparkConnectionDetails.
cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this CreateSparkConnectionDetails.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateSparkConnectionDetails.
technology_type (str) – The value to assign to the technology_type property of this CreateSparkConnectionDetails.
submit_mode (str) – The value to assign to the submit_mode property of this CreateSparkConnectionDetails.
authentication_type (str) – The value to assign to the authentication_type property of this CreateSparkConnectionDetails.
security_protocol (str) – The value to assign to the security_protocol property of this CreateSparkConnectionDetails.
cluster_endpoint (str) – The value to assign to the cluster_endpoint property of this CreateSparkConnectionDetails.
rest_endpoint (str) – The value to assign to the rest_endpoint property of this CreateSparkConnectionDetails.
auth_secret (str) – The value to assign to the auth_secret property of this CreateSparkConnectionDetails.
auth_secret_secret_id (str) – The value to assign to the auth_secret_secret_id property of this CreateSparkConnectionDetails.
rpc_cipher (str) – The value to assign to the rpc_cipher property of this CreateSparkConnectionDetails.
rest_auth_secret_key (str) – The value to assign to the rest_auth_secret_key property of this CreateSparkConnectionDetails.
rest_auth_secret_key_secret_id (str) – The value to assign to the rest_auth_secret_key_secret_id property of this CreateSparkConnectionDetails.
trust_store (str) – The value to assign to the trust_store property of this CreateSparkConnectionDetails.
trust_store_secret_id (str) – The value to assign to the trust_store_secret_id property of this CreateSparkConnectionDetails.
trust_store_password (str) – The value to assign to the trust_store_password property of this CreateSparkConnectionDetails.
trust_store_password_secret_id (str) – The value to assign to the trust_store_password_secret_id property of this CreateSparkConnectionDetails.
trust_store_type (str) – The value to assign to the trust_store_type property of this CreateSparkConnectionDetails.
key_store (str) – The value to assign to the key_store property of this CreateSparkConnectionDetails.
key_store_secret_id (str) – The value to assign to the key_store_secret_id property of this CreateSparkConnectionDetails.
key_store_password (str) – The value to assign to the key_store_password property of this CreateSparkConnectionDetails.
key_store_password_secret_id (str) – The value to assign to the key_store_password_secret_id property of this CreateSparkConnectionDetails.
key_store_type (str) – The value to assign to the key_store_type property of this CreateSparkConnectionDetails.
ssl_key_password (str) – The value to assign to the ssl_key_password property of this CreateSparkConnectionDetails.
ssl_key_password_secret_id (str) – The value to assign to the ssl_key_password_secret_id property of this CreateSparkConnectionDetails.
tls_protocol (str) – The value to assign to the tls_protocol property of this CreateSparkConnectionDetails.
artifact_location (oci.golden_gate.models.CreateSparkArtifactLocationDetails) – The value to assign to the artifact_location property of this CreateSparkConnectionDetails.

artifact_location¶

[Required] Gets the artifact_location of this CreateSparkConnectionDetails.

Returns:	The artifact_location of this CreateSparkConnectionDetails.
Return type:	oci.golden_gate.models.CreateSparkArtifactLocationDetails

auth_secret¶

Gets the auth_secret of this CreateSparkConnectionDetails. The shared secret used for Spark authentication. Applicable when authenticationType is SHARED_SECRET.

Deprecated: This field is deprecated and replaced by “authSecretSecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns:	The auth_secret of this CreateSparkConnectionDetails.
Return type:	str

auth_secret_secret_id¶

Gets the auth_secret_secret_id of this CreateSparkConnectionDetails. The OCID of the Secret that stores the Spark authentication shared secret. Applicable when authenticationType is SHARED_SECRET. Note: When provided, ‘authSecret’ field must not be provided.

Returns:	The auth_secret_secret_id of this CreateSparkConnectionDetails.
Return type:	str

authentication_type¶

[Required] Gets the authentication_type of this CreateSparkConnectionDetails. Authentication type for Spark. AES_RPC and SASL_ENCRYPTED securityProtocol values require authenticationType to be SHARED_SECRET. Use SHARED_SECRET only when the target cluster is configured with spark.authenticate=true.

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

cluster_endpoint¶

[Required] Gets the cluster_endpoint of this CreateSparkConnectionDetails. Spark master URL used for job submission. Required for both submitMode SUBMIT and REST. e.g.: ‘spark://spark-master.example.com:7077’ High availability can be configured with a comma-separated list, for example: ‘spark://h1.example.com:7077,h2.example.com:7077’

Returns:	The cluster_endpoint of this CreateSparkConnectionDetails.
Return type:	str

cluster_placement_group_id¶

Gets the cluster_placement_group_id of this CreateConnectionDetails. 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.

Returns:	The cluster_placement_group_id of this CreateConnectionDetails.
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_AI_DATA_PLATFORM”, “ORACLE_AI_DATA_PLATFORM_ENGINE”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “DATABRICKS_ENGINE”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “SPARK”, “ICEBERG”, “AI_PROVIDER”, “AI_MODEL”

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.

Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

When set to true, all sensitive information must be provided as OCI Vault secrets using the corresponding *SecretId attributes of the connection (for example, passwordSecretId). Plain-text sensitive attributes (for example, password) must not be used. This ensures that sensitive information remains stored and managed in the customer’s OCI Vault rather than by the GoldenGate service.

When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. If vaultId and keyId are not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.

If vaultId and keyId are provided, the specified customer-managed key is used.

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. References the OCI Vault key in the OCI Vault identified by vaultId.

Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

The GoldenGate service uses this key to encrypt sensitive information (for example, password) that is provided in plain-text connection attributes through the API. This field is applicable only when doesUseSecretIds is set to false. If both vaultId and keyId are provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neither vaultId nor keyId is provided, the GoldenGate service uses Oracle-managed encryption keys.

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

key_store¶

Gets the key_store of this CreateSparkConnectionDetails. The base64 encoded content of the client key store used for mutual TLS. Provide this only when the target cluster requires client certificate authentication. Applicable when securityProtocol is TLS.

Deprecated: This field is deprecated and replaced by “keyStoreSecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

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

key_store_password¶

Gets the key_store_password of this CreateSparkConnectionDetails. Password for the client key store. Applicable when securityProtocol is TLS and a client key store is provided. Required when ‘keyStore’ is provided.

Deprecated: This field is deprecated and replaced by “keyStorePasswordSecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

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

key_store_password_secret_id¶

Gets the key_store_password_secret_id of this CreateSparkConnectionDetails. The OCID of the Secret that stores the client key store password. Applicable when securityProtocol is TLS and a client key store is provided. Required when ‘keyStoreSecretId’ is provided. Note: When provided, ‘keyStorePassword’ field must not be provided.

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

key_store_secret_id¶

Gets the key_store_secret_id of this CreateSparkConnectionDetails. The OCID of the Secret that stores the client key store content. Applicable when securityProtocol is TLS. Note: When provided, ‘keyStore’ field must not be provided.

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

key_store_type¶

Gets the key_store_type of this CreateSparkConnectionDetails. Client key store format used for mutual TLS. Applicable when securityProtocol is TLS and a client key store is provided. Defaults to JKS when not provided. Provide this only when a client key store is provided.

Returns:	The key_store_type of this CreateSparkConnectionDetails.
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]

rest_auth_secret_key¶

Gets the rest_auth_secret_key of this CreateSparkConnectionDetails. The BASE64URL-encoded HMAC secret key used to sign REST submission requests when the Spark master’s REST endpoint is protected by the JWS filter. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType.

Deprecated: This field is deprecated and replaced by “restAuthSecretKeySecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns:	The rest_auth_secret_key of this CreateSparkConnectionDetails.
Return type:	str

rest_auth_secret_key_secret_id¶

Gets the rest_auth_secret_key_secret_id of this CreateSparkConnectionDetails. The OCID of the Secret that stores the REST submission signing key. Applicable only when submitMode is REST and the cluster enforces REST request signing. This setting is independent of authenticationType. Note: When provided, ‘restAuthSecretKey’ field must not be provided.

Returns:	The rest_auth_secret_key_secret_id of this CreateSparkConnectionDetails.
Return type:	str

rest_endpoint¶

Gets the rest_endpoint of this CreateSparkConnectionDetails. Spark standalone REST submission base URL. e.g.: ‘https://spark-master.example.com:6066’ Applicable only and required when submitMode is REST.

Returns:	The rest_endpoint of this CreateSparkConnectionDetails.
Return type:	str

routing_method¶

Gets the routing_method of this CreateConnectionDetails. Controls the network traffic direction to the target: 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. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets.

Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

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

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

rpc_cipher¶

Gets the rpc_cipher of this CreateSparkConnectionDetails. Cipher transform used for Spark RPC encryption. Applicable when securityProtocol is AES_RPC. Defaults to AES_CTR_NOPADDING when not provided.

Returns:	The rpc_cipher of this CreateSparkConnectionDetails.
Return type:	str

security_attributes¶

Gets the security_attributes of this CreateConnectionDetails. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}

Returns:	The security_attributes of this CreateConnectionDetails.
Return type:	dict(str, dict(str, object))

security_protocol¶

[Required] Gets the security_protocol of this CreateSparkConnectionDetails. Security protocol for Spark submission traffic. PLAINTEXT uses an unencrypted channel, TLS uses TLS for the selected submission endpoint, AES_RPC uses Spark RPC AES encryption, and SASL_ENCRYPTED uses legacy SASL encryption. AES_RPC and SASL_ENCRYPTED require authenticationType to be SHARED_SECRET.

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

ssl_key_password¶

Gets the ssl_key_password of this CreateSparkConnectionDetails. Password for the certificate private key inside the client key store. Provide this only when it differs from the key store password. Applicable when securityProtocol is TLS and a client key store is provided.

Deprecated: This field is deprecated and replaced by “sslKeyPasswordSecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns:	The ssl_key_password of this CreateSparkConnectionDetails.
Return type:	str

ssl_key_password_secret_id¶

Gets the ssl_key_password_secret_id of this CreateSparkConnectionDetails. The OCID of the Secret that stores the private key password. Applicable when securityProtocol is TLS and a client key store is provided. Note: When provided, ‘sslKeyPassword’ field must not be provided.

Returns:	The ssl_key_password_secret_id of this CreateSparkConnectionDetails.
Return type:	str

submit_mode¶

[Required] Gets the submit_mode of this CreateSparkConnectionDetails. Selects the submission channel. SUBMIT uses the Spark master RPC endpoint. REST uses the Spark standalone REST submission gateway.

Returns:	The submit_mode of this CreateSparkConnectionDetails.
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

subscription_id¶

Gets the subscription_id of this CreateConnectionDetails. The OCID of the subscription with which resource needs to be associated with.

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

technology_type¶

[Required] Gets the technology_type of this CreateSparkConnectionDetails. The Spark technology type.

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

tls_protocol¶

Gets the tls_protocol of this CreateSparkConnectionDetails. TLS protocol negotiated by the Spark client. Applicable when securityProtocol is TLS. Defaults to TLS_V1_3 when not provided. Must be supported by the target cluster.

Returns:	The tls_protocol of this CreateSparkConnectionDetails.
Return type:	str

trust_store¶

Gets the trust_store of this CreateSparkConnectionDetails. The base64 encoded content of the trust store used to validate the Spark server certificate. Applicable when securityProtocol is TLS. Provide this when the server certificate is not already trusted by the JVM.

Deprecated: This field is deprecated and replaced by “trustStoreSecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

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

trust_store_password¶

Gets the trust_store_password of this CreateSparkConnectionDetails. Password for the trust store. Applicable when securityProtocol is TLS and a trust store is provided. Required when ‘trustStore’ is provided.

Deprecated: This field is deprecated and replaced by “trustStorePasswordSecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

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

trust_store_password_secret_id¶

Gets the trust_store_password_secret_id of this CreateSparkConnectionDetails. The OCID of the Secret that stores the trust store password. Applicable when securityProtocol is TLS and a trust store is provided. Required when ‘trustStoreSecretId’ is provided. Note: When provided, ‘trustStorePassword’ field must not be provided.

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

trust_store_secret_id¶

Gets the trust_store_secret_id of this CreateSparkConnectionDetails. The OCID of the Secret that stores the trust store content. Applicable when securityProtocol is TLS. Provide this when the server certificate is not already trusted by the JVM. Note: When provided, ‘trustStore’ field must not be provided.

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

trust_store_type¶

Gets the trust_store_type of this CreateSparkConnectionDetails. Trust store format used by the Spark client. Applicable when securityProtocol is TLS and a trust store is provided. Defaults to JKS when not provided. Provide this only when a trust store is provided.

Returns:	The trust_store_type of this CreateSparkConnectionDetails.
Return type:	str

vault_id¶

Gets the vault_id of this CreateConnectionDetails. References the OCI Vault that contains the customer-managed encryption key identified by keyId.

Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

This field is applicable only when doesUseSecretIds is set to false. If vaultId is provided, keyId must also be provided.

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