MySQL Shell 8.0  /  Getting Started with MySQL Shell  /  Cloud Service Configuration

4.7 Cloud Service Configuration

MySQL Shell supports exporting of MySQL data to cloud service storage and import of that data from cloud storage to a MySQL instance. The following cloud services are supported:

For information on exporting MySQL data to cloud storage, see Section 11.5, “Instance Dump Utility, Schema Dump Utility, and Table Dump Utility”. For information on importing MySQL data from cloud storage, see Section 11.6, “Dump Loading Utility”.

For information on using MySQL Shell with MySQL Database Service, see MySQL Database Service Documentation.

Oracle Cloud Infrastructure Object Storage

MySQL Shell uses the parameters defined in the OCI CLI configuration file, config, to connect to the Object Storage service. For more information on this file, see SDK and CLI Configuration

MySQL Shell requires the following parameters in the configuration file:

  • user: OCID of the user.

  • fingerprint: generated fingerprint of the user's public key.

  • tenancy: OCID of the user's tenancy.

  • region: An Oracle Cloud Infrastructure region.

  • key_file: Full path and filename of the user's public key.

The following is an example of a configuration file:

        [default]
        user=ocid1.user.oc1..alphanumericstring
        fingerprint=08:23:60:....:ff:22:dd:55:20
        tenancy=ocid1.tenancy.oc1..alphanumericstring
        region=us-ashburn-1
        key_file=/home/Username/.oci/oci_api_key.pem

If you have installed and configured the OCI CLI, MySQL Shell reads the connection parameters from the default location, .oci/, automatically. To use an alternate configuration, do so from the command line, using the relevant override options.

S3-compatible Storage

MySQL Shell S3 support has been tested against the following S3-compatible storage services:

MySQL Shell requires the following parameters in one or more configuration files:

  • aws_access_key_id: specifies the access key associated with the user. If not present, an exception is thrown.

  • aws_secret_access_key: specifies the secret key associated with the access key. If not present, an exception is thrown.

  • aws_session_token: specifies the session token required if you are using temporary security credentials. If not present, it is not used to authenticate the user.

  • region: specifies the cloud service region. If not present, the default value of us-east-1 is used.

If you have installed and configured the AWS CLI, MySQL Shell reads the connection parameters from the default location, .aws/, automatically. To use an alternate configuration, do so from the command line, using the relevant override options.

If you are using Oracle Cloud Infrastructure's S3 compatibility API, see Creating a Customer Secret Key for information on creating the credentials required.

Note

By default, the AWS CLI creates two configuration files, config, which stores parameters such as region and output format, and credentials, which stores access keys and session tokens. It is also possible to place all configuration parameters in a single file, config. For more information, see AWS Configuration and authentication settings . However, if you have defined access key and secret access keys in both files, those defined in the credentials file take precedence.

The following example shows a default pair of AWS CLI configuration files:

        /home/.aws/credentials
        
        [default]
        aws_access_key_id = AKIA6AV......
        aws_secret_access_key = XHRY579I.....
        
        /home/.aws/config
        
        [default]
        region = us-west-1
        output = json
Note

MySQL Shell supports AWS CLI config and credentials files, but does not support S3 configuration information stored in environment variables.