service_provider | Specifies the cloud storage service provider that will be used. - AZURE—The service provider will be Microsoft Azure, and accessing a Parquet file is supported.
- AMAZON—The service provider will be Amazon S3, and accessing a Parquet file is supported.
- GOOGLE—The service provider will be Google Cloud Storage, and accessing a Parquet file is supported.
- ALIBABA—The service provider will be Alibaba Cloud Storage.
- WEBHDFS—The service provider will be WebHDFS.
- MINIO—The service provider will be MinIO.
- AZUREDATALAKE—The service provider will be Microsoft Azure Data Lake Storage, and accessing a Parquet file is supported.
- OZONE—The service provider will be Ozone.
- WEB—The service provider that will be used to access generic HTTP URLs.
| String |
config_options [config_options,...] (Optional) | The configuration options pertaining to the specific type of cloud service. Some services offer options, some do not. You only need to set this parameter if you want to turn on the options. Only a subset of options are supported when creating a cloud storage connection file to access a Parquet file, as noted in the following descriptions. - Azure and Microsoft Azure Data Lake Storage
- AZURE_STORAGE_SAS_TOKEN—Specify a shared access signature. Ensure that its
value is URL encoded and does not contain leading '?' or '&' characters. When using this option, the Secret Access Key (Account Key) parameter
must be empty. This option is supported for accessing a Parquet file.
- AZURE_NO_SIGN_REQUEST—Anonymously connect to buckets (containers) that don't
require authenticated access. When using this option, the Secret Access Key (Account Key) parameter
must be empty. The default value is False. This option is supported for accessing a Parquet file.
- AZURE_STORAGE_CONNECTION_STRING—Specify an Azure Storage connection string. This string embeds
the account name, key, and endpoint. When using this option, the Access Key ID (Account Name) and Secret Access Key (Account Key) parameters
must be empty. This option is supported for accessing a Parquet file.
- CPL_AZURE_USE_HTTPS—Set to False to use HTTP requests. Some servers may be configured to only support HTTPS
requests.
The default value is True.
- AZURE_IMDS_OBJECT_ID—Specify the Object ID of the managed identity authenticated using Azure Instance Metadata Service (IMDS) if your Azure VM has multiple user-assigned managed identities set.
- AZURE_IMDS_CLIENT_ID—Specify the Client ID of the managed identity authenticated using Azure IMDS if your Azure VM has multiple user-assigned managed identities set.
- AZURE_IMDS_MSI_RES_ID—Specify the Resource ID of the managed identity authenticated using Azure IMDS if your Azure VM has multiple user-assigned managed identities set.
- Amazon and MinIO
- AWS_NO_SIGN_REQUEST—Anonymously connect to buckets (containers) that don't
require authenticated access. The default value is False. This option is supported for accessing a Parquet file.
- AWS_SESSION_TOKEN—Specify temporary credentials. This option is supported for accessing a Parquet file.
- AWS_S3SESSION_TOKEN—Specify temporary credentials to access a directory bucket.
- AWS_PROFILE—AWS credential
profiles are automatically used when the access key or ID is missing. This
option can be used to specify the profile to use. This option is supported for accessing a Parquet file.
- AWS_REQUEST_PAYER—Requester Pays buckets can be accessed by
setting this option to requester.
- AWS_Virtual_Hosting—If you use Amazon S3 or S3-compatible cloud providers that support only
path-style requests, set this option to True. It is recommended
that you use virtual hosting if it's supported. The default value is True.
- CPL_VSIS3_USE_BASE_RMDIR_RECURSIVE—Some older
S3-compatible implementations do not support the Bulk Delete
operation. Set this option to False for these providers. The default value is True.
- AWS_HTTPS—Set to False to use HTTP requests. Some servers may be configured to only support HTTPS requests. The default value is True.
- Google
- GS_NO_SIGN_REQUEST—Anonymously connect to buckets (containers) that do not
require authenticated access. The default value is True. This option is supported for accessing a Parquet file.
- GS_USER_PROJECT—Requester Pays buckets can be accessed by
setting OAuth2 keys and a project for billing. Set the project using this option and set OAuth2 keys using other options and not HMAC keys as a secret access key or ID.
- GS_OAUTH2_REFRESH_TOKEN—Specify OAuth2 Refresh Access Token. Set OAuth2 client credentials using GS_OAUTH2_CLIENT_ID and GS_OAUTH2_CLIENT_SECRET.
- GOOGLE_APPLICATION_CREDENTIALS—Specify Service Account OAuth2 credentials using a .json file containing a private key and client email address. This option is supported for accessing a Parquet file.
- GS_OAUTH2_PRIVATE_KEY—Specify Service Account OAuth2 credentials using a private key string. GS_AUTH2_CLIENT_EMAIL must be set.
- GS_OAUTH2_PRIVATE_KEY_FILE—Specify Service Account OAuth2 credentials using a private key from a file. GS_AUTH2_CLIENT_EMAIL must be set.
- GS_AUTH2_CLIENT_EMAIL—Specify Service Account OAuth2 credentials using a client email address.
- GS_AUTH2_SCOPE—Specify Service Account OAuth2 scope. Valid values are https://www.googleapis.com/auth/devstorage.read_write (the default) and https://www.googleapis.com/auth/devstorage.read_only.
- GDAL_HTTP_HEADER_FILE—Specify bearer authentication credentials stored in an external file.
- Alibaba
- OSS_Virtual_Hosting—If you use Alibaba or S3-compatible cloud providers that support only
path-style requests, set this option to True. It is recommended
that you use virtual hosting if it's supported. The default value is True.
- OSS_HTTPS—Set to False to use HTTP requests. Some servers may be configured to only support HTTPS requests. The default value is True.
- WebHDFS
- WEBHDFS_REPLICATION (integer)—The replication value is used when
creating a file.
- WEBHDFS_PERMISSION (decimal)—A permission mask
is used when creating a file.
If multiple authentication parameters are provided, precedence
is as follows: In addition to the provider options listed above, the ARC_DEEP_CRAWL option can be used with all of the service providers. If set to True, it is used to identify CRFs with no extension and cloud-enabled raster products in the
cloud. This is operation intensive and it is recommended that you set
this option to False for faster catalog browsing and crawling. The default value is False. Custom token vending services—such as Planetary Computer's data collection, for example—can be authenticated using the ARC_TOKEN_SERVICE_API (the URL of the token vendor) and ARC_TOKEN_OPTION_NAME (the type of token from the service provider) provider options. Note: The GDAL_DISABLE_READDIR_ON_OPEN option is available with all the service providers. To improve the performance of loading cloud-based rasters, this option is set to NO by default. If the raster resides in a folder that contains more than 30,000 items, set this option to YES. | Value Table |