endpoints

Documentation

Index

• Constants
• type Partition
  • func DefaultPartitions() []Partition
  • func PartitionForRegion(ps []Partition, regionID string) (Partition, bool)
  • func (p Partition) DNSSuffix() string
  • func (p Partition) ID() string
  • func (p Partition) Name() string
  • func (p Partition) RegionRegex() *regexp.Regexp
  • func (p Partition) Regions() map[string]Region
  • func (p Partition) Services() map[string]Service
• type Region
  • func (r Region) Description() string
  • func (r Region) ID() string
• type Service
  • func (s Service) ID() string

Constants

const (
	AwsPartitionID      = "aws"        // AWS Standard
	AwsCnPartitionID    = "aws-cn"     // AWS China
	AwsIsoPartitionID   = "aws-iso"    // AWS ISO (US)
	AwsIsoBPartitionID  = "aws-iso-b"  // AWS ISOB (US)
	AwsIsoEPartitionID  = "aws-iso-e"  // AWS ISOE (Europe)
	AwsIsoFPartitionID  = "aws-iso-f"  // AWS ISOF
	AwsUsGovPartitionID = "aws-us-gov" // AWS GovCloud (US)
)

All known partition IDs.

const (
	// AWS Standard partition's Regions.
	AfSouth1RegionID     = "af-south-1"     // Africa (Cape Town)
	ApEast1RegionID      = "ap-east-1"      // Asia Pacific (Hong Kong)
	ApNortheast1RegionID = "ap-northeast-1" // Asia Pacific (Tokyo)
	ApNortheast2RegionID = "ap-northeast-2" // Asia Pacific (Seoul)
	ApNortheast3RegionID = "ap-northeast-3" // Asia Pacific (Osaka)
	ApSouth1RegionID     = "ap-south-1"     // Asia Pacific (Mumbai)
	ApSouth2RegionID     = "ap-south-2"     // Asia Pacific (Hyderabad)
	ApSoutheast1RegionID = "ap-southeast-1" // Asia Pacific (Singapore)
	ApSoutheast2RegionID = "ap-southeast-2" // Asia Pacific (Sydney)
	ApSoutheast3RegionID = "ap-southeast-3" // Asia Pacific (Jakarta)
	ApSoutheast4RegionID = "ap-southeast-4" // Asia Pacific (Melbourne)
	ApSoutheast5RegionID = "ap-southeast-5" // Asia Pacific (Malaysia)
	ApSoutheast7RegionID = "ap-southeast-7" // Asia Pacific (Thailand)
	CaCentral1RegionID   = "ca-central-1"   // Canada (Central)
	CaWest1RegionID      = "ca-west-1"      // Canada West (Calgary)
	EuCentral1RegionID   = "eu-central-1"   // Europe (Frankfurt)
	EuCentral2RegionID   = "eu-central-2"   // Europe (Zurich)
	EuNorth1RegionID     = "eu-north-1"     // Europe (Stockholm)
	EuSouth1RegionID     = "eu-south-1"     // Europe (Milan)
	EuSouth2RegionID     = "eu-south-2"     // Europe (Spain)
	EuWest1RegionID      = "eu-west-1"      // Europe (Ireland)
	EuWest2RegionID      = "eu-west-2"      // Europe (London)
	EuWest3RegionID      = "eu-west-3"      // Europe (Paris)
	IlCentral1RegionID   = "il-central-1"   // Israel (Tel Aviv)
	MeCentral1RegionID   = "me-central-1"   // Middle East (UAE)
	MeSouth1RegionID     = "me-south-1"     // Middle East (Bahrain)
	MxCentral1RegionID   = "mx-central-1"   // Mexico (Central)
	SaEast1RegionID      = "sa-east-1"      // South America (Sao Paulo)
	UsEast1RegionID      = "us-east-1"      // US East (N. Virginia)
	UsEast2RegionID      = "us-east-2"      // US East (Ohio)
	UsWest1RegionID      = "us-west-1"      // US West (N. California)
	UsWest2RegionID      = "us-west-2"      // US West (Oregon)
	// AWS China partition's Regions.
	CnNorth1RegionID     = "cn-north-1"     // China (Beijing)
	CnNorthwest1RegionID = "cn-northwest-1" // China (Ningxia)
	// AWS ISO (US) partition's Regions.
	UsIsoEast1RegionID = "us-iso-east-1" // US ISO East
	UsIsoWest1RegionID = "us-iso-west-1" // US ISO WEST
	// AWS ISOB (US) partition's Regions.
	UsIsobEast1RegionID = "us-isob-east-1" // US ISOB East (Ohio)
	// AWS ISOE (Europe) partition's Regions.
	EuIsoeWest1RegionID = "eu-isoe-west-1" // EU ISOE West
	// AWS ISOF partition's Regions.
	// AWS GovCloud (US) partition's Regions.
	UsGovEast1RegionID = "us-gov-east-1" // AWS GovCloud (US-East)
	UsGovWest1RegionID = "us-gov-west-1" // AWS GovCloud (US-West)
)

All known Region IDs.

const (
	AwsGlobalRegionID = "aws-global" // AWS Standard global region.
)

Types

type Partition

type Partition struct {
	// contains filtered or unexported fields
}

Partition represents an AWS partition. See https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html.

func DefaultPartitions

func DefaultPartitions() []Partition

DefaultPartitions returns a list of the partitions.

func PartitionForRegion

func PartitionForRegion(ps []Partition, regionID string) (Partition, bool)

PartitionForRegion returns the first partition which includes the specific Region.

func (Partition) DNSSuffix

func (p Partition) DNSSuffix() string

DNSSuffix returns the base domain name of the partition.

func (Partition) ID

func (p Partition) ID() string

ID returns the identifier of the partition.

func (Partition) Name

func (p Partition) Name() string

Name returns the name of the partition.

func (Partition) RegionRegex

func (p Partition) RegionRegex() *regexp.Regexp

RegionRegex return the regular expression that matches Region IDs for the partition.

func (Partition) Regions

func (p Partition) Regions() map[string]Region

Regions returns a map of Regions for the partition, indexed by their ID.

func (Partition) Services

func (p Partition) Services() map[string]Service

Services returns a map of service endpoints for the partition, indexed by their ID.

type Region

type Region struct {
	// contains filtered or unexported fields
}

Region represents an AWS Region. See https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/regions.html.

func (Region) Description

func (r Region) Description() string

Description returns the Region's description.

func (Region) ID

func (r Region) ID() string

ID returns the Region's identifier.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service represents an AWS service endpoint.

func (Service) ID

func (s Service) ID() string

ID returns the service endpoint's identifier.