create

Description

Creates a connection under an existing data asset.

Usage

oci data-integration connection create [OPTIONS]

Required Parameters

--identifier [text]

Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be edited by the user.

--name [text]

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value can be edited by the user and it is restricted to 1000 characters

--workspace-id [text]

DIS workspace id

Optional Parameters

--connection-properties [complex type]

The properties for the connection.

This option is a JSON list with items of type ConnectionProperty. For documentation on ConnectionProperty please see our API reference: https://docs.cloud.oracle.com/api/#/en/dataintegration/20200430/datatypes/ConnectionProperty. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--credential-file-content [text]

The credential file content from a wallet for the data asset.

--description [text]

Detailed description for the object.

--finger-print [text]

The fingeprint for the user.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id --> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our "using CLI with advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--key [text]

Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create.

--model-type [text]

The type of the connection.

Accepted values are:

ORACLEDB_CONNECTION, ORACLE_ADWC_CONNECTION, ORACLE_ATP_CONNECTION, ORACLE_OBJECT_STORAGE_CONNECTION
--model-version [text]

The model version of an object.

--object-status [integer]

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

--parent-ref [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--pass-phrase [text]

The pass phrase for the connection.

--password [text]

The password for the connection.

--registry-metadata [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--user-id [text]

The OCI user OCID for the user to connect to.

--username [text]

The user name for the connection.