RegionInfo Class
Information pertaining to an AWS region.
Example
ts
// Get the information for "eu-west-1":
const region = regionInfo.RegionInfo.get('eu-west-1');
// Access attributes:
region.s3StaticWebsiteEndpoint; // s3-website-eu-west-1.amazonaws.com
Properties
appMeshRepositoryAccountmay be undefinedstringapp_mesh_repository_accountmay be undefinedstrappMeshRepositoryAccountmay be undefinedStringAppMeshRepositoryAccountmay be undefinedstringAppMeshRepositoryAccountmay be undefined*string#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.
cdkMetadataResourceAvailablebooleancdk_metadata_resource_availableboolcdkMetadataResourceAvailableBooleanCdkMetadataResourceAvailableboolCdkMetadataResourceAvailable*bool#Whether the `AWS::CDK::Metadata` CloudFormation Resource is available in this region or not.
dlcRepositoryAccountmay be undefinedstringdlc_repository_accountmay be undefinedstrdlcRepositoryAccountmay be undefinedStringDlcRepositoryAccountmay be undefinedstringDlcRepositoryAccountmay be undefined*string#The ID of the AWS account that owns the public ECR repository containing the AWS Deep Learning Containers images in this region.
domainSuffixmay be undefinedstringdomain_suffixmay be undefinedstrdomainSuffixmay be undefinedStringDomainSuffixmay be undefinedstringDomainSuffixmay be undefined*string#The domain name suffix (e.g: amazonaws.com) for this region.
ebsEnvEndpointHostedZoneIdmay be undefinedstringebs_env_endpoint_hosted_zone_idmay be undefinedstrebsEnvEndpointHostedZoneIdmay be undefinedStringEbsEnvEndpointHostedZoneIdmay be undefinedstringEbsEnvEndpointHostedZoneIdmay be undefined*string#The hosted zone ID used by Route 53 to alias a EBS environment endpoint in this region (e.g: Z2O1EMRO9K5GLX).
elbv2Accountmay be undefinedstringelbv2_accountmay be undefinedstrelbv2Accountmay be undefinedStringElbv2Accountmay be undefinedstringElbv2Accountmay be undefined*string#The account ID for ELBv2 in this region.
firehoseCidrBlockmay be undefinedstringfirehose_cidr_blockmay be undefinedstrfirehoseCidrBlockmay be undefinedStringFirehoseCidrBlockmay be undefinedstringFirehoseCidrBlockmay be undefined*string#The CIDR block used by Amazon Data Firehose servers.
Whether the given region is an opt-in region.
partitionmay be undefinedstringpartitionmay be undefinedstrpartitionmay be undefinedStringPartitionmay be undefinedstringPartitionmay be undefined*string#The name of the ARN partition for this region (e.g: aws).
regionsRegionInfo[]regionstyping.List[RegionInfo]regionsList<RegionInfo>RegionsRegionInfo[]Regions*[]RegionInfostatic#s3StaticWebsiteEndpointmay be undefinedstrings3_static_website_endpointmay be undefinedstrs3StaticWebsiteEndpointmay be undefinedStringS3StaticWebsiteEndpointmay be undefinedstringS3StaticWebsiteEndpointmay be undefined*string#The endpoint used by S3 static website hosting in this region (e.g: s3-static-website-us-east-1.amazonaws.com).
s3StaticWebsiteHostedZoneIdmay be undefinedstrings3_static_website_hosted_zone_idmay be undefinedstrs3StaticWebsiteHostedZoneIdmay be undefinedStringS3StaticWebsiteHostedZoneIdmay be undefinedstringS3StaticWebsiteHostedZoneIdmay be undefined*string#The hosted zone ID used by Route 53 to alias a S3 static website in this region (e.g: Z2O1EMRO9K5GLX).
samlSignOnUrlmay be undefinedstringsaml_sign_on_urlmay be undefinedstrsamlSignOnUrlmay be undefinedStringSamlSignOnUrlmay be undefinedstringSamlSignOnUrlmay be undefined*string#SAML Sign On URL used by IAM SAML Principals.
vpcEndpointServiceNamePrefixmay be undefinedstringvpc_endpoint_service_name_prefixmay be undefinedstrvpcEndpointServiceNamePrefixmay be undefinedStringVpcEndpointServiceNamePrefixmay be undefinedstringVpcEndpointServiceNamePrefixmay be undefined*string#The prefix for VPC Endpoint Service names, cn.com.amazonaws.vpce for China regions, com.amazonaws.vpce otherwise.
Methods
adotLambdaLayerArn(type: string, version: string, architecture: string): stringdef adot_lambda_layer_arn(self, type: str, version: str, architecture: str) -> strpublic String adotLambdaLayerArn(String type, String version, String architecture)public string AdotLambdaLayerArn(string type, string version, string architecture)func AdotLambdaLayerArn(Type *string, Version *string, Architecture *string) *string#The ARN of the ADOT Lambda layer, for the given layer type, version and architecture.
3 parameters
Parameters
typetypetypetypeType— the type of the ADOT lambda layer.versionversionversionversionVersion— the layer version.architecturearchitecturearchitecturearchitectureArchitecture— the Lambda Function architecture (e.g. 'x86_64' or 'arm64').
appConfigLambdaArn(layerVersion: string, architecture?: string): stringdef app_config_lambda_arn(self, layer_version: str, architecture: typing.Optional[str] = None) -> strpublic String appConfigLambdaArn(String layerVersion, String architecture)public string AppConfigLambdaArn(string layerVersion, string? architecture = null)func AppConfigLambdaArn(LayerVersion *string, Architecture *string) *string#The ARN of the AppConfig Lambda Layer, for the given version.
2 parameters
Parameters
layerVersionlayer_versionlayerVersionlayerVersionLayerVersion— The layer version (e.g. 2.0.181).architecturearchitecturearchitecturearchitectureArchitecture— The Lambda Function architecture (e.g. 'x86_64' or 'arm64'), defaults to x86_64.
cloudwatchLambdaInsightsArn(insightsVersion: string, architecture?: string): stringdef cloudwatch_lambda_insights_arn(self, insights_version: str, architecture: typing.Optional[str] = None) -> strpublic String cloudwatchLambdaInsightsArn(String insightsVersion, String architecture)public string CloudwatchLambdaInsightsArn(string insightsVersion, string? architecture = null)func CloudwatchLambdaInsightsArn(InsightsVersion *string, Architecture *string) *string#The ARN of the CloudWatch Lambda Insights extension, for the given version.
2 parameters
Parameters
insightsVersioninsights_versioninsightsVersioninsightsVersionInsightsVersion— the version (e.g. 1.0.98.0).architecturearchitecturearchitecturearchitectureArchitecture— the Lambda Function architecture (e.g. 'x86_64' or 'arm64').
get(name: string): RegionInfo // chainable@staticmethod def get(name: str) -> RegionInfopublic static RegionInfo get(String name)public static RegionInfo Get(string name)func Get(Name *string) RegionInfostatic#Obtain region info for a given region name.
1 parameter
Parameters
namenamenamenameName— the name of the region (e.g: us-east-1).
limitedRegionMap(factName: string, partitions: string[]): { [key: string]: string }@staticmethod def limited_region_map(fact_name: str, partitions: typing.List[str]) -> typing.Mapping[str, str]public static Map<String, String> limitedRegionMap(String factName, List<String> partitions)public static IDictionary<string, string> LimitedRegionMap(string factName, string[] partitions)func LimitedRegionMap(FactName *string, Partitions *[]*string) *map[string]*stringstatic#Retrieves a collection of all fact values for all regions, limited to some partitions.
2 parameters · returns
Parameters
factNamefact_namefactNamefactNameFactName— the name of the fact to retrieve values for.partitionspartitionspartitionspartitionsPartitions— list of partitions to retrieve facts for.
Returns: a mapping with AWS region codes as the keys, and the fact in the given region as the value for that key
paramsAndSecretsLambdaLayerArn(version: string, architecture: string): stringdef params_and_secrets_lambda_layer_arn(self, version: str, architecture: str) -> strpublic String paramsAndSecretsLambdaLayerArn(String version, String architecture)public string ParamsAndSecretsLambdaLayerArn(string version, string architecture)func ParamsAndSecretsLambdaLayerArn(Version *string, Architecture *string) *string#The ARN of the Parameters and Secrets Lambda layer for the given lambda architecture.
2 parameters
Parameters
versionversionversionversionVersion— the layer version.architecturearchitecturearchitecturearchitectureArchitecture— the Lambda Function architecture (e.g. 'x86_64' or 'arm64').
regionMap(factName: string): { [key: string]: string }@staticmethod def region_map(fact_name: str) -> typing.Mapping[str, str]public static Map<String, String> regionMap(String factName)public static IDictionary<string, string> RegionMap(string factName)func RegionMap(FactName *string) *map[string]*stringstatic#Retrieves a collection of all fact values for all regions that fact is defined in.
1 parameter · returns
Parameters
factNamefact_namefactNamefactNameFactName— the name of the fact to retrieve values for.
Returns: a mapping with AWS region codes as the keys, and the fact in the given region as the value for that key
servicePrincipal(service: string): stringdef service_principal(self, service: str) -> strpublic String servicePrincipal(String service)public string ServicePrincipal(string service)func ServicePrincipal(Service *string) *stringdeprecated#- Use `iam.ServicePrincipal.servicePrincipalName()` instead.
1 parameter
Parameters
serviceserviceserviceserviceService— the service name (e.g: s3.amazonaws.com).