# RegionInfo

Information pertaining to an AWS region.

- Source: [`region-info/lib/region-info.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/region-info/lib/region-info.ts#L7)
- Type last changed: v2.150.0 · 23 Jul 2024

## 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

- `appMeshRepositoryAccount`: 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.

- `cdkMetadataResourceAvailable`: boolean — Whether the `AWS::CDK::Metadata` CloudFormation Resource is available in this region or not.

- `dlcRepositoryAccount`: string — The ID of the AWS account that owns the public ECR repository containing the AWS Deep Learning Containers images in this region.

- `domainSuffix`: string — The domain name suffix (e.g: amazonaws.com) for this region.

- `ebsEnvEndpointHostedZoneId`: string — The hosted zone ID used by Route 53 to alias a EBS environment endpoint in this region (e.g: Z2O1EMRO9K5GLX).

- `elbv2Account`: string — The account ID for ELBv2 in this region.

- `firehoseCidrBlock`: string — The CIDR block used by Amazon Data Firehose servers.

- `isOptInRegion`: boolean — Whether the given region is an opt-in region.

- `name`: string

- `partition`: string — The name of the ARN partition for this region (e.g: aws).

- `regions`: [RegionInfo](/cdk/api/v2/docs/aws-cdk-lib.region_info.RegionInfo.html)[] (static)

- `s3StaticWebsiteEndpoint`: string — The endpoint used by S3 static website hosting in this region (e.g: s3-static-website-us-east-1.amazonaws.com).

- `s3StaticWebsiteHostedZoneId`: string — The hosted zone ID used by Route 53 to alias a S3 static website in this region (e.g: Z2O1EMRO9K5GLX).

- `samlSignOnUrl`: string — SAML Sign On URL used by IAM SAML Principals.

- `vpcEndpointServiceNamePrefix`: 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): string` — The ARN of the ADOT Lambda layer, for the given layer type, version and architecture.

  **Parameters**

  - `type` — the type of the ADOT lambda layer.
  - `version` — the layer version.
  - `architecture` — the Lambda Function architecture (e.g. 'x86_64' or 'arm64').

- `appConfigLambdaArn(layerVersion: string, architecture?: string): string` — The ARN of the AppConfig Lambda Layer, for the given version.

  **Parameters**

  - `layerVersion` — The layer version (e.g. 2.0.181).
  - `architecture` — The Lambda Function architecture (e.g. 'x86_64' or 'arm64'), defaults to x86_64.

- `cloudwatchLambdaInsightsArn(insightsVersion: string, architecture?: string): string` — The ARN of the CloudWatch Lambda Insights extension, for the given version.

  **Parameters**

  - `insightsVersion` — the version (e.g. 1.0.98.0).
  - `architecture` — the Lambda Function architecture (e.g. 'x86_64' or 'arm64').

- `get(name: string): RegionInfo // chainable` (static) — Obtain region info for a given region name.

  **Parameters**

  - `name` — the name of the region (e.g: us-east-1).

- `limitedRegionMap(factName: string, partitions: string[]): { [key: string]: string }` (static) — Retrieves a collection of all fact values for all regions, limited to some partitions.

  **Parameters**

  - `factName` — the name of the fact to retrieve values for.
  - `partitions` — 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): string` — The ARN of the Parameters and Secrets Lambda layer for the given lambda architecture.

  **Parameters**

  - `version` — the layer version.
  - `architecture` — the Lambda Function architecture (e.g. 'x86_64' or 'arm64').

- `regionMap(factName: string): { [key: string]: string }` (static) — Retrieves a collection of all fact values for all regions that fact is defined in.

  **Parameters**

  - `factName` — 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): string` — - Use `iam.ServicePrincipal.servicePrincipalName()` instead.

  **Parameters**

  - `service` — the service name (e.g: s3.amazonaws.com).