Socket
Socket
Sign inDemoInstall

aws-regions

Package Overview
Dependencies
0
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

aws-regions

List of AWS Regions and Availability Zones


Version published
Maintainers
1
Weekly downloads
476
decreased by-29.06%

Weekly downloads

Readme

Source

AWS Regions - Javascript

Usage

$ npm install aws-regions

.list(options: Object)

Returns all the regions.

const awsRegions = require('aws-regions')

awsRegions.list() ===
	[
		{
			name: 'N. Virginia',
			full_name: 'US East (N. Virginia)',
			code: 'us-east-1',
			public: true,
			zones: [
				'us-east-1a',
				// ...
			],
		},
		// ...
	]
  • options
    • public If true, will only return regions publicly available with a regular AWS account. Defaults to false.

.lookup(options: Object)

Finds a region by the name or the code.

const awsRegions = require('aws-regions')

awsRegions.lookup({ code: 'us-east-1' }) ===
	{
		name: 'N. Virginia',
		full_name: 'US East (N. Virginia)',
		code: 'us-east-1',
		public: true,
		zones: [
			'us-east-1a',
			// ...
		],
	}
  • options
    • code Lookup a region by its code (e.g. us-east-1).
    • name Lookup a region by its name (e.g. N. Virginia).

Zone Limit

If a region's data object includes zone_limit: int, that means AWS accounts are limited to this number of availability zones (which will differ based on when your account was created.) You'll need to get your specific availability zones for this region with the AWS API or CLI.

Regions List

Keywords

FAQs

Last updated on 24 Dec 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc