Class RegionInfo
Information pertaining to an AWS region.
Inheritance
Namespace: Amazon.CDK.RegionInfo
Assembly: Amazon.CDK.RegionInfo.dll
Syntax (csharp)
public class RegionInfo : DeputyBase
Syntax (vb)
Public Class RegionInfo
Inherits DeputyBase
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.RegionInfo;
var regionInfo = RegionInfo.Get("name");
Synopsis
Constructors
RegionInfo(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
RegionInfo(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AppMeshRepositoryAccount | 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 | Whether the |
DlcRepositoryAccount | The ID of the AWS account that owns the public ECR repository containing the AWS Deep Learning Containers images in this region. |
DomainSuffix | The domain name suffix (e.g: amazonaws.com) for this region. |
EbsEnvEndpointHostedZoneId | The hosted zone ID used by Route 53 to alias a EBS environment endpoint in this region (e.g: Z2O1EMRO9K5GLX). |
Elbv2Account | The account ID for ELBv2 in this region. |
FirehoseCidrBlock | The CIDR block used by Kinesis Data Firehose servers. |
IsOptInRegion | Whether the given region is an opt-in region. |
Name | |
Partition | The name of the ARN partition for this region (e.g: aws). |
Regions | |
S3StaticWebsiteEndpoint | The endpoint used by S3 static website hosting in this region (e.g: s3-static-website-us-east-1.amazonaws.com). |
S3StaticWebsiteHostedZoneId | The hosted zone ID used by Route 53 to alias a S3 static website in this region (e.g: Z2O1EMRO9K5GLX). |
SamlSignOnUrl | SAML Sign On URL used by IAM SAML Principals. |
VpcEndpointServiceNamePrefix | The prefix for VPC Endpoint Service names, cn.com.amazonaws.vpce for China regions, com.amazonaws.vpce otherwise. |
Methods
AdotLambdaLayerArn(String, String, String) | The ARN of the ADOT Lambda layer, for the given layer type, version and architecture. |
AppConfigLambdaArn(String, String) | The ARN of the AppConfig Lambda Layer, for the given version. |
CloudwatchLambdaInsightsArn(String, String) | The ARN of the CloudWatch Lambda Insights extension, for the given version. |
Get(String) | Obtain region info for a given region name. |
LimitedRegionMap(String, String[]) | Retrieves a collection of all fact values for all regions, limited to some partitions. |
ParamsAndSecretsLambdaLayerArn(String, String) | The ARN of the Parameters and Secrets Lambda layer for the given lambda architecture. |
RegionMap(String) | Retrieves a collection of all fact values for all regions that fact is defined in. |
ServicePrincipal(String) | (deprecated) The name of the service principal for a given service in this region. |
Constructors
RegionInfo(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected RegionInfo(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
RegionInfo(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected RegionInfo(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AppMeshRepositoryAccount
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.
public virtual string AppMeshRepositoryAccount { get; }
Property Value
System.String
CdkMetadataResourceAvailable
Whether the AWS::CDK::Metadata
CloudFormation Resource is available in this region or not.
public virtual bool CdkMetadataResourceAvailable { get; }
Property Value
System.Boolean
DlcRepositoryAccount
The ID of the AWS account that owns the public ECR repository containing the AWS Deep Learning Containers images in this region.
public virtual string DlcRepositoryAccount { get; }
Property Value
System.String
DomainSuffix
The domain name suffix (e.g: amazonaws.com) for this region.
public virtual string DomainSuffix { get; }
Property Value
System.String
EbsEnvEndpointHostedZoneId
The hosted zone ID used by Route 53 to alias a EBS environment endpoint in this region (e.g: Z2O1EMRO9K5GLX).
public virtual string EbsEnvEndpointHostedZoneId { get; }
Property Value
System.String
Elbv2Account
The account ID for ELBv2 in this region.
public virtual string Elbv2Account { get; }
Property Value
System.String
FirehoseCidrBlock
The CIDR block used by Kinesis Data Firehose servers.
public virtual string FirehoseCidrBlock { get; }
Property Value
System.String
IsOptInRegion
Whether the given region is an opt-in region.
public virtual bool IsOptInRegion { get; }
Property Value
System.Boolean
Name
public virtual string Name { get; }
Property Value
System.String
Partition
The name of the ARN partition for this region (e.g: aws).
public virtual string Partition { get; }
Property Value
System.String
Regions
public static RegionInfo[] Regions { get; }
Property Value
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.
S3StaticWebsiteEndpoint
The endpoint used by S3 static website hosting in this region (e.g: s3-static-website-us-east-1.amazonaws.com).
public virtual string S3StaticWebsiteEndpoint { get; }
Property Value
System.String
S3StaticWebsiteHostedZoneId
The hosted zone ID used by Route 53 to alias a S3 static website in this region (e.g: Z2O1EMRO9K5GLX).
public virtual string S3StaticWebsiteHostedZoneId { get; }
Property Value
System.String
SamlSignOnUrl
SAML Sign On URL used by IAM SAML Principals.
public virtual string SamlSignOnUrl { get; }
Property Value
System.String
VpcEndpointServiceNamePrefix
The prefix for VPC Endpoint Service names, cn.com.amazonaws.vpce for China regions, com.amazonaws.vpce otherwise.
public virtual string VpcEndpointServiceNamePrefix { get; }
Property Value
System.String
Methods
AdotLambdaLayerArn(String, String, String)
The ARN of the ADOT Lambda layer, for the given layer type, version and architecture.
public virtual string AdotLambdaLayerArn(string type, string version, string architecture)
Parameters
- type System.String
the type of the ADOT lambda layer.
- version System.String
the layer version.
- architecture System.String
the Lambda Function architecture (e.g. 'x86_64' or 'arm64').
Returns
System.String
AppConfigLambdaArn(String, String)
The ARN of the AppConfig Lambda Layer, for the given version.
public virtual string AppConfigLambdaArn(string layerVersion, string architecture = null)
Parameters
- layerVersion System.String
The layer version (e.g. 2.0.181).
- architecture System.String
The Lambda Function architecture (e.g. 'x86_64' or 'arm64'), defaults to x86_64.
Returns
System.String
CloudwatchLambdaInsightsArn(String, String)
The ARN of the CloudWatch Lambda Insights extension, for the given version.
public virtual string CloudwatchLambdaInsightsArn(string insightsVersion, string architecture = null)
Parameters
- insightsVersion System.String
the version (e.g. 1.0.98.0).
- architecture System.String
the Lambda Function architecture (e.g. 'x86_64' or 'arm64').
Returns
System.String
Get(String)
Obtain region info for a given region name.
public static RegionInfo Get(string name)
Parameters
- name System.String
the name of the region (e.g: us-east-1).
Returns
LimitedRegionMap(String, String[])
Retrieves a collection of all fact values for all regions, limited to some partitions.
public static IDictionary<string, string> LimitedRegionMap(string factName, string[] partitions)
Parameters
- factName System.String
the name of the fact to retrieve values for.
- partitions System.String[]
list of partitions to retrieve facts for.
Returns
System.Collections.Generic.IDictionary<System.String, System.String>
a mapping with AWS region codes as the keys, and the fact in the given region as the value for that key
ParamsAndSecretsLambdaLayerArn(String, String)
The ARN of the Parameters and Secrets Lambda layer for the given lambda architecture.
public virtual string ParamsAndSecretsLambdaLayerArn(string version, string architecture)
Parameters
- version System.String
the layer version.
- architecture System.String
the Lambda Function architecture (e.g. 'x86_64' or 'arm64').
Returns
System.String
RegionMap(String)
Retrieves a collection of all fact values for all regions that fact is defined in.
public static IDictionary<string, string> RegionMap(string factName)
Parameters
- factName System.String
the name of the fact to retrieve values for.
Returns
System.Collections.Generic.IDictionary<System.String, System.String>
a mapping with AWS region codes as the keys, and the fact in the given region as the value for that key
ServicePrincipal(String)
(deprecated) The name of the service principal for a given service in this region.
public virtual string ServicePrincipal(string service)
Parameters
- service System.String
the service name (e.g: s3.amazonaws.com).
Returns
System.String
Remarks
Stability: Deprecated