regioninfo

Documentation

Index

• func Default_ServicePrincipal(serviceFqn *string, region *string, urlSuffix *string) *string
• func Default_VPC_ENDPOINT_SERVICE_NAME_PREFIX() *string
• func FactName_APPMESH_ECR_ACCOUNT() *string
• func FactName_CDK_METADATA_RESOURCE_AVAILABLE() *string
• func FactName_CloudwatchLambdaInsightsVersion(version *string, arch *string) *string
• func FactName_DLC_REPOSITORY_ACCOUNT() *string
• func FactName_DOMAIN_SUFFIX() *string
• func FactName_EBS_ENV_ENDPOINT_HOSTED_ZONE_ID() *string
• func FactName_ELBV2_ACCOUNT() *string
• func FactName_FIREHOSE_CIDR_BLOCK() *string
• func FactName_PARTITION() *string
• func FactName_S3_STATIC_WEBSITE_ENDPOINT() *string
• func FactName_S3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_ID() *string
• func FactName_ServicePrincipal(service *string) *string
• func FactName_VPC_ENDPOINT_SERVICE_NAME_PREFIX() *string
• func Fact_Find(region *string, name *string) *string
• func Fact_Regions() *[]*string
• func Fact_Register(fact IFact, allowReplacing *bool)
• func Fact_RequireFact(region *string, name *string) *string
• func Fact_Unregister(region *string, name *string, value *string)
• func NewFactName_Override(f FactName)
• func RegionInfo_LimitedRegionMap(factName *string, partitions *[]*string) *map[string]*string
• func RegionInfo_RegionMap(factName *string) *map[string]*string
• func RegionInfo_Regions() *[]RegionInfo
• type Default
• type Fact
• type FactName
  • func NewFactName() FactName
• type IFact
• type RegionInfo
  • func RegionInfo_Get(name *string) RegionInfo

Functions

func Default_ServicePrincipal

func Default_ServicePrincipal(serviceFqn *string, region *string, urlSuffix *string) *string

Computes a "standard" AWS Service principal for a given service, region and suffix.

This is useful for example when you need to compute a service principal name, but you do not have a synthesize-time region literal available (so all you have is `{ "Ref": "AWS::Region" }`). This way you get the same defaulting behavior that is normally used for built-in data.

func Default_VPC_ENDPOINT_SERVICE_NAME_PREFIX

func Default_VPC_ENDPOINT_SERVICE_NAME_PREFIX() *string

func FactName_APPMESH_ECR_ACCOUNT

func FactName_APPMESH_ECR_ACCOUNT() *string

func FactName_CDK_METADATA_RESOURCE_AVAILABLE

func FactName_CDK_METADATA_RESOURCE_AVAILABLE() *string

func FactName_CloudwatchLambdaInsightsVersion

func FactName_CloudwatchLambdaInsightsVersion(version *string, arch *string) *string

The ARN of CloudWatch Lambda Insights for a version (e.g. 1.0.98.0).

func FactName_DLC_REPOSITORY_ACCOUNT

func FactName_DLC_REPOSITORY_ACCOUNT() *string

func FactName_DOMAIN_SUFFIX

func FactName_DOMAIN_SUFFIX() *string

func FactName_EBS_ENV_ENDPOINT_HOSTED_ZONE_ID

func FactName_EBS_ENV_ENDPOINT_HOSTED_ZONE_ID() *string

func FactName_ELBV2_ACCOUNT

func FactName_ELBV2_ACCOUNT() *string

func FactName_FIREHOSE_CIDR_BLOCK

func FactName_FIREHOSE_CIDR_BLOCK() *string

func FactName_PARTITION

func FactName_PARTITION() *string

func FactName_S3_STATIC_WEBSITE_ENDPOINT

func FactName_S3_STATIC_WEBSITE_ENDPOINT() *string

func FactName_S3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_ID

func FactName_S3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_ID() *string

func FactName_ServicePrincipal

func FactName_ServicePrincipal(service *string) *string

The name of the regional service principal for a given service.

func FactName_VPC_ENDPOINT_SERVICE_NAME_PREFIX

func FactName_VPC_ENDPOINT_SERVICE_NAME_PREFIX() *string

func Fact_Find

func Fact_Find(region *string, name *string) *string

Retrieves a fact from this Fact database.

Returns: the fact value if it is known, and `undefined` otherwise.

func Fact_Regions

func Fact_Regions() *[]*string

func Fact_Register

func Fact_Register(fact IFact, allowReplacing *bool)

Registers a new fact in this Fact database.

func Fact_RequireFact

func Fact_RequireFact(region *string, name *string) *string

Retrieve a fact from the Fact database.

(retrieval will fail if the specified region or fact name does not exist.)

func Fact_Unregister

func Fact_Unregister(region *string, name *string, value *string)

Removes a fact from the database.

func NewFactName_Override

func NewFactName_Override(f FactName)

func RegionInfo_LimitedRegionMap

func RegionInfo_LimitedRegionMap(factName *string, partitions *[]*string) *map[string]*string

Retrieves a collection of all fact values for all regions, limited to some partitions.

Returns: a mapping with AWS region codes as the keys, and the fact in the given region as the value for that key.

func RegionInfo_RegionMap

func RegionInfo_RegionMap(factName *string) *map[string]*string

Retrieves a collection of all fact values for all regions that fact is defined in.

Returns: a mapping with AWS region codes as the keys, and the fact in the given region as the value for that key.

func RegionInfo_Regions

func RegionInfo_Regions() *[]RegionInfo

Types

type Default

type Default interface {
}

Provides default values for certain regional information points.

type Fact

type Fact interface {
}

A database of regional information.

Example:

type myFact struct {
	region
	name
	value
}

regionInfo.fact.register(NewMyFact())

type FactName

type FactName interface {
}

All standardized fact names.

Example:

type myFact struct {
	region
	name
	value
}

regionInfo.fact.register(NewMyFact())

func NewFactName

func NewFactName() FactName

type IFact

type IFact interface {
	// The name of this fact.
	//
	// Standardized values are provided by the `Facts` class.
	Name() *string
	// The region for which this fact applies.
	Region() *string
	// The value of this fact.
	Value() *string
}

A fact that can be registered about a particular region.

type RegionInfo

type RegionInfo interface {
	// The ID of the AWS account that owns the public ECR repository that contains the AWS App Mesh Envoy Proxy images in a given region.
	AppMeshRepositoryAccount() *string
	// Whether the `AWS::CDK::Metadata` CloudFormation Resource is available in this region or not.
	CdkMetadataResourceAvailable() *bool
	// The ID of the AWS account that owns the public ECR repository containing the AWS Deep Learning Containers images in this region.
	DlcRepositoryAccount() *string
	// The domain name suffix (e.g: amazonaws.com) for this region.
	DomainSuffix() *string
	// The hosted zone ID used by Route 53 to alias a EBS environment endpoint in this region (e.g: Z2O1EMRO9K5GLX).
	EbsEnvEndpointHostedZoneId() *string
	// The account ID for ELBv2 in this region.
	Elbv2Account() *string
	// The CIDR block used by Kinesis Data Firehose servers.
	FirehoseCidrBlock() *string
	Name() *string
	// The name of the ARN partition for this region (e.g: aws).
	Partition() *string
	// The endpoint used by S3 static website hosting in this region (e.g: s3-static-website-us-east-1.amazonaws.com).
	S3StaticWebsiteEndpoint() *string
	// The hosted zone ID used by Route 53 to alias a S3 static website in this region (e.g: Z2O1EMRO9K5GLX).
	S3StaticWebsiteHostedZoneId() *string
	// The prefix for VPC Endpoint Service names, cn.com.amazonaws.vpce for China regions, com.amazonaws.vpce otherwise.
	VpcEndpointServiceNamePrefix() *string
	// The ARN of the CloudWatch Lambda Insights extension, for the given version.
	CloudwatchLambdaInsightsArn(insightsVersion *string, architecture *string) *string
	// The name of the service principal for a given service in this region.
	ServicePrincipal(service *string) *string
}

Information pertaining to an AWS region.

Example:

// Get the information for "eu-west-1":
region := regionInfo.regionInfo.get(jsii.String("eu-west-1"))

// Access attributes:
region.s3StaticWebsiteEndpoint // s3-website-eu-west-1.amazonaws.com
region.servicePrincipal(jsii.String("logs.amazonaws.com"))

func RegionInfo_Get

func RegionInfo_Get(name *string) RegionInfo

Obtain region info for a given region name.