awscli-plugin-endpoint
=============
This awscli plugin provides service endpoint configuration **per service** on profile.
------------
Installation
------------
The easiest way to install awscli-plugin-endpoint is to use `pip`:
$ pip install awscli-plugin-endpoint
You can also install the latest package from GitHub source which can contain changes not yet pushed to PyPI:
$ pip install git+https://github.com/wbingli/awscli-plugin-endpoint.git
or, if you install `awscli` via Homebrew, which bundles its own python, install as following:
$ /usr/local/opt/awscli/libexec/bin/pip install awscli-plugin-endpoint
---------------
Getting Started
---------------
Before using awscli-plugin-endpoint plugin, you need to [configure awscli](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) first.
**MUST**: Once that's done, to enable `awscli-plugin-endpoint` plugin, you can run:
$ aws configure set plugins.endpoint awscli_plugin_endpoint
The above command adds below section to your aws config file. You can also directly edit your `~/.aws/config` with below configuration.
[plugins]
endpoint = awscli_plugin_endpoint
To add endpoint configure to a profile(assuming you have a **local** profile), you can run:
$ aws configure --profile local set dynamodb.endpoint_url http://localhost:8000
The above command adds below section to your profile:
[profile local]
dynamodb =
endpoint_url = http://localhost:8000
Now you can access your local dynamodb just use profile:
$ aws dynamodb list-tables --profile local
## One more example with S3 configuration
Add endpoint configuration to the profile:
$ aws configure --profile wasabi set s3.endpoint_url https://s3.wasabisys.com
The profile will looks like below:
[profile wasabi]
region = us-east-1
s3 =
endpoint_url = https://s3.wasabisys.com
Now you can use `aws s3` command with this profile as following:
$ aws s3 ls --profile wasabi
One more thing, the endpoint is technically per **sub command**. Take S3 as example, above S3 configuration will not work for S3 low level CLI `aws s3api`. To make `s3api` work with this endpoint, you should add endpoint to this sub command as well:
[profile wasabi]
region = us-east-1
s3 =
endpoint_url = https://s3.wasabisys.com
s3api =
endpoint_url = https://s3.wasabisys.com
Now you can use `aws s3api` command with this profile as following:
$ aws s3api --profile wasabi list-buckets
Working with Secure Connections
------------------
By default, awscli verifies the certificates presented for all HTTPS requests.
There are two options for working with self-signed or otherwise untrusted
certificates:
* `ca_bundle`
If the certificate is long-lived, or any new certificates will be issued by
a long-lived certificate authority, you may want to provide an alternate
set of trusted certificates with `ca_bundle`. This is comparable to the
`--ca-bundle` command line option, and may be specified either per-profile
or per-subcommand:
[profile local1]
ca_bundle = /path/to/bundle.crt
s3 =
endpoint_url = https://localhost:8000
[profile local2]
ec2 =
ca_bundle = /path/to/another-bundle.crt
endpoint_url = https://localhost:8888
* `verify_ssl`
If the certificate will be frequently refreshed, you may want to simply
disable verification with `verify_ssl = false`. This is comparable to the
`--no-verify-ssl` command line option:
[profile local]
dynamodb =
verify_ssl = false
endpoint_url = https://localhost:8000
Raw data
{
"_id": null,
"home_page": "https://github.com/wbingli/awscli-plugin-endpoint",
"name": "awscli-plugin-endpoint",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "awscli,plugin,endpoint",
"author": "Wenbing Li",
"author_email": "wbingli@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c7/e0/35562467505ded087e994cfa177e497050fd2df3e8b91b681cb8227bc1c7/awscli-plugin-endpoint-0.4.tar.gz",
"platform": "",
"description": "awscli-plugin-endpoint\n=============\n\nThis awscli plugin provides service endpoint configuration **per service** on profile.\n\n------------\nInstallation\n------------\n\nThe easiest way to install awscli-plugin-endpoint is to use `pip`:\n\n $ pip install awscli-plugin-endpoint\n\nYou can also install the latest package from GitHub source which can contain changes not yet pushed to PyPI:\n\n $ pip install git+https://github.com/wbingli/awscli-plugin-endpoint.git\n\nor, if you install `awscli` via Homebrew, which bundles its own python, install as following:\n\n $ /usr/local/opt/awscli/libexec/bin/pip install awscli-plugin-endpoint\n\n\n---------------\nGetting Started\n---------------\n\nBefore using awscli-plugin-endpoint plugin, you need to [configure awscli](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) first.\n\n**MUST**: Once that's done, to enable `awscli-plugin-endpoint` plugin, you can run:\n\n $ aws configure set plugins.endpoint awscli_plugin_endpoint\n\nThe above command adds below section to your aws config file. You can also directly edit your `~/.aws/config` with below configuration.\n\n [plugins]\n endpoint = awscli_plugin_endpoint\n\nTo add endpoint configure to a profile(assuming you have a **local** profile), you can run:\n\n $ aws configure --profile local set dynamodb.endpoint_url http://localhost:8000\n\nThe above command adds below section to your profile:\n\n [profile local]\n dynamodb =\n endpoint_url = http://localhost:8000\n\nNow you can access your local dynamodb just use profile:\n\n $ aws dynamodb list-tables --profile local\n\n## One more example with S3 configuration\n\nAdd endpoint configuration to the profile:\n\n $ aws configure --profile wasabi set s3.endpoint_url https://s3.wasabisys.com\n\nThe profile will looks like below:\n\n [profile wasabi]\n region = us-east-1\n s3 =\n endpoint_url = https://s3.wasabisys.com\n\nNow you can use `aws s3` command with this profile as following:\n\n $ aws s3 ls --profile wasabi\n\nOne more thing, the endpoint is technically per **sub command**. Take S3 as example, above S3 configuration will not work for S3 low level CLI `aws s3api`. To make `s3api` work with this endpoint, you should add endpoint to this sub command as well:\n\n [profile wasabi]\n region = us-east-1\n s3 =\n endpoint_url = https://s3.wasabisys.com\n s3api =\n endpoint_url = https://s3.wasabisys.com\n\nNow you can use `aws s3api` command with this profile as following:\n\n $ aws s3api --profile wasabi list-buckets\n\n\nWorking with Secure Connections\n------------------\nBy default, awscli verifies the certificates presented for all HTTPS requests.\nThere are two options for working with self-signed or otherwise untrusted\ncertificates:\n\n* `ca_bundle`\n\n If the certificate is long-lived, or any new certificates will be issued by\n a long-lived certificate authority, you may want to provide an alternate\n set of trusted certificates with `ca_bundle`. This is comparable to the\n `--ca-bundle` command line option, and may be specified either per-profile\n or per-subcommand:\n\n [profile local1]\n ca_bundle = /path/to/bundle.crt\n s3 =\n endpoint_url = https://localhost:8000\n\n [profile local2]\n ec2 =\n ca_bundle = /path/to/another-bundle.crt\n endpoint_url = https://localhost:8888\n\n* `verify_ssl`\n\n If the certificate will be frequently refreshed, you may want to simply\n disable verification with `verify_ssl = false`. This is comparable to the\n `--no-verify-ssl` command line option:\n\n [profile local]\n dynamodb =\n verify_ssl = false\n endpoint_url = https://localhost:8000\n\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Endpoint plugin for AWS CLI",
"version": "0.4",
"project_urls": {
"Download": "https://github.com/wbingli/awscli-plugin-endpoint/tarball/0.4",
"Homepage": "https://github.com/wbingli/awscli-plugin-endpoint"
},
"split_keywords": [
"awscli",
"plugin",
"endpoint"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33ef1c8d9b181ca03e96ce0c03fe7b79ab3c8440660ecb767d84ca05f6420d2b",
"md5": "4f4cac631bf1bf4e564673b6662cba46",
"sha256": "7c855a897748822e3b0f25e2b25b5ddce4b483cb7a5becf0abc94161e0913b29"
},
"downloads": -1,
"filename": "awscli_plugin_endpoint-0.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f4cac631bf1bf4e564673b6662cba46",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7633,
"upload_time": "2020-07-22T06:30:04",
"upload_time_iso_8601": "2020-07-22T06:30:04.549360Z",
"url": "https://files.pythonhosted.org/packages/33/ef/1c8d9b181ca03e96ce0c03fe7b79ab3c8440660ecb767d84ca05f6420d2b/awscli_plugin_endpoint-0.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c7e035562467505ded087e994cfa177e497050fd2df3e8b91b681cb8227bc1c7",
"md5": "5cd97dc28a90597697c729ab4a051d6a",
"sha256": "9096f01f637f17e7b0c28788a64276acc40c0165f1655a6dc45fec39b96bafd0"
},
"downloads": -1,
"filename": "awscli-plugin-endpoint-0.4.tar.gz",
"has_sig": false,
"md5_digest": "5cd97dc28a90597697c729ab4a051d6a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3680,
"upload_time": "2020-07-22T06:30:05",
"upload_time_iso_8601": "2020-07-22T06:30:05.887708Z",
"url": "https://files.pythonhosted.org/packages/c7/e0/35562467505ded087e994cfa177e497050fd2df3e8b91b681cb8227bc1c7/awscli-plugin-endpoint-0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-07-22 06:30:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wbingli",
"github_project": "awscli-plugin-endpoint",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "awscli-plugin-endpoint"
}
JSON
