2.168.0

class RegionInfo

LanguageType name
.NETAmazon.CDK.RegionInfo.RegionInfo
Gogithub.com/aws/aws-cdk-go/awscdk/v2/regioninfo#RegionInfo
Javasoftware.amazon.awscdk.regioninfo.RegionInfo
Pythonaws_cdk.region_info.RegionInfo
TypeScript (source)aws-cdk-lib » region_info » RegionInfo

Information pertaining to an AWS region.

Example

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

NameTypeDescription
cdkMetadataResourceAvailablebooleanWhether the AWS::CDK::Metadata CloudFormation Resource is available in this region or not.
isOptInRegionbooleanWhether the given region is an opt-in region.
namestring
appMeshRepositoryAccount?stringThe ID of the AWS account that owns the public ECR repository that contains the AWS App Mesh Envoy Proxy images in a given region.
dlcRepositoryAccount?stringThe ID of the AWS account that owns the public ECR repository containing the AWS Deep Learning Containers images in this region.
domainSuffix?stringThe domain name suffix (e.g: amazonaws.com) for this region.
ebsEnvEndpointHostedZoneId?stringThe hosted zone ID used by Route 53 to alias a EBS environment endpoint in this region (e.g: Z2O1EMRO9K5GLX).
elbv2Account?stringThe account ID for ELBv2 in this region.
firehoseCidrBlock?stringThe CIDR block used by Kinesis Data Firehose servers.
partition?stringThe name of the ARN partition for this region (e.g: aws).
s3StaticWebsiteEndpoint?stringThe endpoint used by S3 static website hosting in this region (e.g: s3-static-website-us-east-1.amazonaws.com).
s3StaticWebsiteHostedZoneId?stringThe hosted zone ID used by Route 53 to alias a S3 static website in this region (e.g: Z2O1EMRO9K5GLX).
samlSignOnUrl?stringSAML Sign On URL used by IAM SAML Principals.
vpcEndpointServiceNamePrefix?stringThe prefix for VPC Endpoint Service names, cn.com.amazonaws.vpce for China regions, com.amazonaws.vpce otherwise.
static regionsRegionInfo[]

cdkMetadataResourceAvailable

Type: boolean

Whether the AWS::CDK::Metadata CloudFormation Resource is available in this region or not.

isOptInRegion

Type: boolean

Whether the given region is an opt-in region.

name

Type: string

appMeshRepositoryAccount?

Type: string (optional)

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.

dlcRepositoryAccount?

Type: string (optional)

The ID of the AWS account that owns the public ECR repository containing the AWS Deep Learning Containers images in this region.

domainSuffix?

Type: string (optional)

The domain name suffix (e.g: amazonaws.com) for this region.

ebsEnvEndpointHostedZoneId?

Type: string (optional)

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

elbv2Account?

Type: string (optional)

The account ID for ELBv2 in this region.

firehoseCidrBlock?

Type: string (optional)

The CIDR block used by Kinesis Data Firehose servers.

partition?

Type: string (optional)

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

s3StaticWebsiteEndpoint?

Type: string (optional)

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

s3StaticWebsiteHostedZoneId?

Type: string (optional)

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

samlSignOnUrl?

Type: string (optional)

SAML Sign On URL used by IAM SAML Principals.

vpcEndpointServiceNamePrefix?

Type: string (optional)

The prefix for VPC Endpoint Service names, cn.com.amazonaws.vpce for China regions, com.amazonaws.vpce otherwise.

static regions

Type: RegionInfo[]

Methods

NameDescription
adotLambdaLayerArn(type, version, architecture)The ARN of the ADOT Lambda layer, for the given layer type, version and architecture.
appConfigLambdaArn(layerVersion, architecture?)The ARN of the AppConfig Lambda Layer, for the given version.
cloudwatchLambdaInsightsArn(insightsVersion, architecture?)The ARN of the CloudWatch Lambda Insights extension, for the given version.
paramsAndSecretsLambdaLayerArn(version, architecture)The ARN of the Parameters and Secrets Lambda layer for the given lambda architecture.
servicePrincipal(service)⚠️The name of the service principal for a given service in this region.
static get(name)Obtain region info for a given region name.
static limitedRegionMap(factName, partitions)Retrieves a collection of all fact values for all regions, limited to some partitions.
static regionMap(factName)Retrieves a collection of all fact values for all regions that fact is defined in.

adotLambdaLayerArn(type, version, architecture)

public adotLambdaLayerArn(type: string, version: string, architecture: string): string

Parameters

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

Returns

  • string

The ARN of the ADOT Lambda layer, for the given layer type, version and architecture.

appConfigLambdaArn(layerVersion, architecture?)

public appConfigLambdaArn(layerVersion: string, architecture?: string): string

Parameters

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

Returns

  • string

The ARN of the AppConfig Lambda Layer, for the given version.

cloudwatchLambdaInsightsArn(insightsVersion, architecture?)

public cloudwatchLambdaInsightsArn(insightsVersion: string, architecture?: string): string

Parameters

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

Returns

  • string

The ARN of the CloudWatch Lambda Insights extension, for the given version.

paramsAndSecretsLambdaLayerArn(version, architecture)

public paramsAndSecretsLambdaLayerArn(version: string, architecture: string): string

Parameters

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

Returns

  • string

The ARN of the Parameters and Secrets Lambda layer for the given lambda architecture.

servicePrincipal(service)⚠️

public servicePrincipal(service: string): string

⚠️ Deprecated: - Use iam.ServicePrincipal.servicePrincipalName() instead.

Parameters

  • service string — the service name (e.g: s3.amazonaws.com).

Returns

  • string

The name of the service principal for a given service in this region.

static get(name)

public static get(name: string): RegionInfo

Parameters

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

Returns

Obtain region info for a given region name.

static limitedRegionMap(factName, partitions)

public static limitedRegionMap(factName: string, partitions: string[]): { [string]: string }

Parameters

  • factName string — the name of the fact to retrieve values for.
  • partitions string[] — list of partitions to retrieve facts for.

Returns

  • { [string]: string }

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

static regionMap(factName)

public static regionMap(factName: string): { [string]: string }

Parameters

  • factName string — the name of the fact to retrieve values for.

Returns

  • { [string]: string }

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

← PreviousNext →