CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails¶
- class oci.golden_gate.models.CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails(**kwargs)¶
Bases:
CreateDatabricksEngineOciObjectStorageConfigDetailsSecret-key authentication and location details for creating an OCI Object Storage Databricks Engine artifact location. Provide exactly one of secretAccessKey or secretAccessKeySecretId.
Methods:
__init__(**kwargs)Initializes a new CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails 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.
Attributes:
[Required] Gets the access_key_id of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
[Required] Gets the authentication_type of this CreateDatabricksEngineOciObjectStorageConfigDetails.
[Required] Gets the bucket of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
[Required] Gets the namespace of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
[Required] Gets the path of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
Gets the region of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
Gets the secret_access_key of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
Gets the secret_access_key_secret_id of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
- __init__(**kwargs)¶
Initializes a new CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails object with values from keyword arguments. The default value of the
authentication_typeattribute of this class isCUSTOMER_SECRET_KEYand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
authentication_type (str) – The value to assign to the authentication_type property of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
region (str) – The value to assign to the region property of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
namespace (str) – The value to assign to the namespace property of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
bucket (str) – The value to assign to the bucket property of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
path (str) – The value to assign to the path property of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
access_key_id (str) – The value to assign to the access_key_id property of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
secret_access_key (str) – The value to assign to the secret_access_key property of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
secret_access_key_secret_id (str) – The value to assign to the secret_access_key_secret_id property of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
- property access_key_id¶
[Required] Gets the access_key_id of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails. Access key identifier used for OCI Object Storage secret-key authentication. Note: Despite the “Id” suffix, this value is not an OCI OCID.
- Returns
The access_key_id of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
- Return type
str
- property authentication_type¶
[Required] Gets the authentication_type of this CreateDatabricksEngineOciObjectStorageConfigDetails. Authentication method used to access OCI Object Storage.
When authenticationType is USER_PRINCIPAL, region, namespace, bucket, path, userId, and publicKeyFingerprint are required. Provide exactly one of privateKeyFile or privateKeyFileSecretId as the private-key credential. tenancyId and the private-key passphrase are optional. When a passphrase is used, provide at most one of privateKeyPassphrase or privateKeyPassphraseSecretId.
When authenticationType is RESOURCE_PRINCIPAL, region, namespace, bucket, and path are required.
When authenticationType is CUSTOMER_SECRET_KEY, region, namespace, bucket, path, and accessKeyId are required. Provide exactly one of secretAccessKey or secretAccessKeySecretId as the secret-key credential. The S3 Compatibility API endpoint is inferred from region and namespace.
When authenticationType is PRE_AUTHENTICATED_REQUEST, provide exactly one of parUrl or parUrlSecretId.
- Returns
The authentication_type of this CreateDatabricksEngineOciObjectStorageConfigDetails.
- Return type
str
- property bucket¶
[Required] Gets the bucket of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails. Bucket containing Databricks application artifacts.
- Returns
The bucket of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
- Return type
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.
- property namespace¶
[Required] Gets the namespace of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails. The OCI Object Storage namespace containing the bucket. Example: “mynamespace”
- Returns
The namespace of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
- Return type
str
- property path¶
[Required] Gets the path of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails. Object path used for Databricks application artifacts.
- Returns
The path of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
- Return type
str
- property region¶
Gets the region of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails. The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the current region.
- Returns
The region of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
- Return type
str
- property secret_access_key¶
Gets the secret_access_key of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails. Secret access key used for OCI Object Storage secret-key authentication. Deprecated: This field is deprecated and replaced by “secretAccessKeySecretId”. 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 secret_access_key of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
- Return type
str
- property secret_access_key_secret_id¶
Gets the secret_access_key_secret_id of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails. The OCID of the Secret that stores the secret access key. Note: When provided, secretAccessKey must not be provided.
- Returns
The secret_access_key_secret_id of this CreateDatabricksEngineSecretKeyOciObjectStorageConfigDetails.
- Return type
str