``create`` ========== .. contents:: :local: :depth: 1 Description ------------ Creates a new pipeline. Usage ----- .. code-block:: none oci gdp pipeline create [OPTIONS] Required Parameters -------------------- .. option:: --bucket-details [complex type] Information about the bucket in the pipeline being configured. 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 :option:`--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. .. option:: --compartment-id, -c [text] The OCID of the compartment. .. option:: --display-name [text] Pipeline short name. .. option:: --peering-region [text] Public region name where the peered pipeline exists. .. option:: --pipeline-type [text] Type of pipeline. Can be SENDER or RECEIVER. Optional Parameters -------------------- .. option:: --approval-key-vault-id [text] The KMS vault OCID for the key to be used for file transfer approvals. .. option:: --authorization-details [text] Authorization information about the pipeline being configured. .. option:: --defined-tags [complex type] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` 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 :option:`--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. .. option:: --description [text] Short field input by customer for a description of the data pipeline use-case. .. option:: --file-types [complex type] List of file types allowed to be transferred in the pipeline according to the authorization details (e.g. .pdf, .xml, .doc). 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 :option:`--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. .. option:: --freeform-tags [complex type] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` 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 :option:`--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. .. option:: --from-json [text] Provide input to this command as a JSON document from a file using the file://path-to/file syntax. The :option:`--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 .. option:: --is-approval-needed [boolean] Determines whether file transfers need to go through an approval workflow. .. option:: --is-chunking-enabled [boolean] Specifies whether the file should be chunked during transfer. This option needs for both SENDER and Receiver pipelines. Chunking is required for large file transfers and recommended for optimal performance. .. option:: --is-fileoverride-enabled [boolean] Enable file override feature in destination bucket .. option:: --is-scanning-enabled [boolean] Determines whether GDP Scanning should be enabled for the pipeline. .. option:: --service-log-group-id [text] the OCID of the service log group. Global Parameters ------------------ Use ``oci --help`` for help on global parameters. :option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--enable-dual-stack`, :option:`--enable-propagation`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v` Example using required parameter ------------------ Copy and paste the following example into a JSON file, replacing the example parameters with your own. .. code-block:: none :class: copy-code-block oci gdp pipeline create --generate-param-json-input bucket-details > bucket-details.json Copy the following CLI commands into a file named example.sh. Run the command by typing "bash example.sh" and replacing the example parameters with your own. Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up `the OCI configuration `__ and `appropriate security policies `__ before trying the examples. .. code-block:: none :class: copy-code-block export compartment_id= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdp/pipeline/create.html#cmdoption-compartment-id export display_name= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdp/pipeline/create.html#cmdoption-display-name export peering_region= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdp/pipeline/create.html#cmdoption-peering-region export pipeline_type= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/gdp/pipeline/create.html#cmdoption-pipeline-type oci gdp pipeline create --bucket-details file://bucket-details.json --compartment-id $compartment_id --display-name $display_name --peering-region $peering_region --pipeline-type $pipeline_type