Package 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.104.0 (build e79254c)", date="2024-11-22T02:24:11.166Z") @Stability(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();

  • Constructor Details

    • RegionInfo

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

    • RegionInfo

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

  • Method Details

    • get

      @Stability(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(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(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

    • adotLambdaLayerArn

      @Stability(Stable) @Nullable public String adotLambdaLayerArn(@NotNull String type, @NotNull String version, @NotNull String architecture)
      The ARN of the ADOT Lambda layer, for the given layer type, version and architecture.

      Parameters:
      type - the type of the ADOT lambda layer. This parameter is required.
      version - the layer version. This parameter is required.
      architecture - the Lambda Function architecture (e.g. 'x86_64' or 'arm64'). This parameter is required.

    • appConfigLambdaArn

      @Stability(Stable) @Nullable public String appConfigLambdaArn(@NotNull String layerVersion, @Nullable String architecture)
      The ARN of the AppConfig Lambda Layer, for the given version.

      Parameters:
      layerVersion - The layer version (e.g. 2.0.181). This parameter is required.
      architecture - The Lambda Function architecture (e.g. 'x86_64' or 'arm64'), defaults to x86_64.

    • appConfigLambdaArn

      @Stability(Stable) @Nullable public String appConfigLambdaArn(@NotNull String layerVersion)
      The ARN of the AppConfig Lambda Layer, for the given version.

      Parameters:
      layerVersion - The layer version (e.g. 2.0.181). This parameter is required.

    • cloudwatchLambdaInsightsArn

      @Stability(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(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.

    • paramsAndSecretsLambdaLayerArn

      @Stability(Stable) @Nullable public String paramsAndSecretsLambdaLayerArn(@NotNull String version, @NotNull String architecture)
      The ARN of the Parameters and Secrets Lambda layer for the given lambda architecture.

      Parameters:
      version - the layer version. This parameter is required.
      architecture - the Lambda Function architecture (e.g. 'x86_64' or 'arm64'). This parameter is required.

    • servicePrincipal

      @Stability(Deprecated) @Deprecated @Nullable public String servicePrincipal(@NotNull String service)
      Deprecated.
      • Use iam.ServicePrincipal.servicePrincipalName() instead.
      (deprecated) 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(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(Stable) @NotNull public Boolean getCdkMetadataResourceAvailable()
      Whether the AWS::CDK::Metadata CloudFormation Resource is available in this region or not.

    • getIsOptInRegion

      @Stability(Stable) @NotNull public Boolean getIsOptInRegion()
      Whether the given region is an opt-in region.

    • getName

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

    • getAppMeshRepositoryAccount

      @Stability(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(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(Stable) @Nullable public String getDomainSuffix()
      The domain name suffix (e.g: amazonaws.com) for this region.

    • getEbsEnvEndpointHostedZoneId

      @Stability(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(Stable) @Nullable public String getElbv2Account()
      The account ID for ELBv2 in this region.

    • getFirehoseCidrBlock

      @Stability(Stable) @Nullable public String getFirehoseCidrBlock()
      The CIDR block used by Kinesis Data Firehose servers.

    • getPartition

      @Stability(Stable) @Nullable public String getPartition()
      The name of the ARN partition for this region (e.g: aws).

    • getS3StaticWebsiteEndpoint

      @Stability(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(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).

    • getSamlSignOnUrl

      @Stability(Stable) @Nullable public String getSamlSignOnUrl()
      SAML Sign On URL used by IAM SAML Principals.

    • getVpcEndpointServiceNamePrefix

      @Stability(Stable) @Nullable public String getVpcEndpointServiceNamePrefix()
      The prefix for VPC Endpoint Service names, cn.com.amazonaws.vpce for China regions, com.amazonaws.vpce otherwise.