software.amazon.awscdk.regioninfo

Class RegionInfo

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.regioninfo.RegionInfo

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.52.1 (build 5ccc8f6)",
           date="2022-02-09T01:04:31.182Z")
 @Stability(value=Stable)
public class RegionInfo
extends software.amazon.jsii.JsiiObject

Information pertaining to an AWS region.

Example:

 // Get the information for "eu-west-1":
 RegionInfo region = RegionInfo.get("eu-west-1");
 // Access attributes:
 region.getS3StaticWebsiteEndpoint(); // s3-website-eu-west-1.amazonaws.com
 region.servicePrincipal("logs.amazonaws.com");
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionInfo(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	RegionInfo(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	cloudwatchLambdaInsightsArn(String insightsVersion) The ARN of the CloudWatch Lambda Insights extension, for the given version.
String	cloudwatchLambdaInsightsArn(String insightsVersion, String architecture) The ARN of the CloudWatch Lambda Insights extension, for the given version.
static RegionInfo	get(String name) Obtain region info for a given region name.
String	getAppMeshRepositoryAccount() 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.
Boolean	getCdkMetadataResourceAvailable() Whether the `AWS::CDK::Metadata` CloudFormation Resource is available in this region or not.
String	getDlcRepositoryAccount() The ID of the AWS account that owns the public ECR repository containing the AWS Deep Learning Containers images in this region.
String	getDomainSuffix() The domain name suffix (e.g: amazonaws.com) for this region.
String	getEbsEnvEndpointHostedZoneId() The hosted zone ID used by Route 53 to alias a EBS environment endpoint in this region (e.g: Z2O1EMRO9K5GLX).
String	getElbv2Account() The account ID for ELBv2 in this region.
String	getFirehoseCidrBlock() The CIDR block used by Kinesis Data Firehose servers.
String	getName()
String	getPartition() The name of the ARN partition for this region (e.g: aws).
static List<RegionInfo>	getRegions()
String	getS3StaticWebsiteEndpoint() The endpoint used by S3 static website hosting in this region (e.g: s3-static-website-us-east-1.amazonaws.com).
String	getS3StaticWebsiteHostedZoneId() The hosted zone ID used by Route 53 to alias a S3 static website in this region (e.g: Z2O1EMRO9K5GLX).
String	getVpcEndpointServiceNamePrefix() The prefix for VPC Endpoint Service names, cn.com.amazonaws.vpce for China regions, com.amazonaws.vpce otherwise.
static Map<String,String>	limitedRegionMap(String factName, List<String> partitions) Retrieves a collection of all fact values for all regions, limited to some partitions.
static Map<String,String>	regionMap(String factName) Retrieves a collection of all fact values for all regions that fact is defined in.
String	servicePrincipal(String service) The name of the service principal for a given service in this region.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

RegionInfo

protected RegionInfo(software.amazon.jsii.JsiiObjectRef objRef)

RegionInfo

protected RegionInfo(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

get

@Stability(value=Stable)
 @NotNull
public static RegionInfo get(@NotNull
                                                                String name)

Obtain region info for a given region name.

Parameters:

name - the name of the region (e.g: us-east-1). This parameter is required.

limitedRegionMap

@Stability(value=Stable)
 @NotNull
public static Map<String,String> limitedRegionMap(@NotNull
                                                                                     String factName,
                                                                                     @NotNull
                                                                                     List<String> partitions)

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. This parameter is required.

partitions - list of partitions to retrieve facts for. This parameter is required.

Returns:

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

regionMap

@Stability(value=Stable)
 @NotNull
public static Map<String,String> regionMap(@NotNull
                                                                              String factName)

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. This parameter is required.

Returns:

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

cloudwatchLambdaInsightsArn

@Stability(value=Stable)
 @Nullable
public String cloudwatchLambdaInsightsArn(@NotNull
                                                                              String insightsVersion,
                                                                              @Nullable
                                                                              String architecture)

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

Parameters:

insightsVersion - the version (e.g. 1.0.98.0). This parameter is required.

architecture - the Lambda Function architecture (e.g. 'x86_64' or 'arm64').

cloudwatchLambdaInsightsArn

@Stability(value=Stable)
 @Nullable
public String cloudwatchLambdaInsightsArn(@NotNull
                                                                              String insightsVersion)

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

Parameters:

insightsVersion - the version (e.g. 1.0.98.0). This parameter is required.

servicePrincipal

@Stability(value=Stable)
 @Nullable
public String servicePrincipal(@NotNull
                                                                   String service)

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

Parameters:

service - the service name (e.g: s3.amazonaws.com). This parameter is required.

getRegions

@Stability(value=Stable)
 @NotNull
public static List<RegionInfo> getRegions()

Returns:

the list of names of AWS regions for which there is at least one registered fact. This may not be an exaustive list of all available AWS regions.

getCdkMetadataResourceAvailable

@Stability(value=Stable)
 @NotNull
public Boolean getCdkMetadataResourceAvailable()

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

getName

@Stability(value=Stable)
 @NotNull
public String getName()

getAppMeshRepositoryAccount

@Stability(value=Stable)
 @Nullable
public String getAppMeshRepositoryAccount()

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.

getDlcRepositoryAccount

@Stability(value=Stable)
 @Nullable
public String getDlcRepositoryAccount()

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

getDomainSuffix

@Stability(value=Stable)
 @Nullable
public String getDomainSuffix()

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

getEbsEnvEndpointHostedZoneId

@Stability(value=Stable)
 @Nullable
public String getEbsEnvEndpointHostedZoneId()

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

getElbv2Account

@Stability(value=Stable)
 @Nullable
public String getElbv2Account()

The account ID for ELBv2 in this region.

getFirehoseCidrBlock

@Stability(value=Stable)
 @Nullable
public String getFirehoseCidrBlock()

The CIDR block used by Kinesis Data Firehose servers.

getPartition

@Stability(value=Stable)
 @Nullable
public String getPartition()

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

getS3StaticWebsiteEndpoint

@Stability(value=Stable)
 @Nullable
public String getS3StaticWebsiteEndpoint()

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

getS3StaticWebsiteHostedZoneId

@Stability(value=Stable)
 @Nullable
public String getS3StaticWebsiteHostedZoneId()

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

getVpcEndpointServiceNamePrefix

@Stability(value=Stable)
 @Nullable
public String getVpcEndpointServiceNamePrefix()

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