aws-cdk-lib.region_info.FactName

FactName Class

All standardized fact names.

Source

region-info/lib/fact.ts

Type last changed

v2.150.0 · 23 Jul 2024

Example

class MyFact implements regionInfo.IFact {
  public readonly region = 'bermuda-triangle-1';
  public readonly name = regionInfo.FactName.S3_STATIC_WEBSITE_ENDPOINT;
  public readonly value = 's3-website.bermuda-triangle-1.nowhere.com';
}

regionInfo.Fact.register(new MyFact());

@jsii.implements(region_info.IFact)
class MyFact:

region_info.Fact.register(MyFact())

public class MyFact implements IFact {
    public final Object region;
    public final Object name;
    public final Object value;
}

Fact.register(new MyFact());

// Install: dotnet add package Amazon.CDK.Lib
class MyFact : IFact
{
    public readonly void Region = "bermuda-triangle-1";
    public readonly void Name = FactName.S3_STATIC_WEBSITE_ENDPOINT;
    public readonly void Value = "s3-website.bermuda-triangle-1.nowhere.com";
}

Fact.Register(new MyFact());

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
type myFact struct {
	region
	name
	value
}

regionInfo.Fact_Register(newMyFact())

Initializer

new FactName()

FactName()

new FactName()

new FactName()

NewFactName()

Properties

APPMESH_ECR_ACCOUNTstringappmesh_ecr_accountstrAPPMESH_ECR_ACCOUNTStringAPPMESH_ECR_ACCOUNTstringAPPMESH_ECR_ACCOUNT*stringstatic#

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.

CDK_METADATA_RESOURCE_AVAILABLEstringcdk_metadata_resource_availablestrCDK_METADATA_RESOURCE_AVAILABLEStringCDK_METADATA_RESOURCE_AVAILABLEstringCDK_METADATA_RESOURCE_AVAILABLE*stringstatic#

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

The value is a boolean modelled as YES or NO.

DLC_REPOSITORY_ACCOUNTstringdlc_repository_accountstrDLC_REPOSITORY_ACCOUNTStringDLC_REPOSITORY_ACCOUNTstringDLC_REPOSITORY_ACCOUNT*stringstatic#

The ID of the AWS account that owns the public ECR repository that contains the AWS Deep Learning Containers images in a given region.

DOMAIN_SUFFIXstringdomain_suffixstrDOMAIN_SUFFIXStringDOMAIN_SUFFIXstringDOMAIN_SUFFIX*stringstatic#

The domain suffix for a region (e.g: 'amazonaws.com`).

EBS_ENV_ENDPOINT_HOSTED_ZONE_IDstringebs_env_endpoint_hosted_zone_idstrEBS_ENV_ENDPOINT_HOSTED_ZONE_IDStringEBS_ENV_ENDPOINT_HOSTED_ZONE_IDstringEBS_ENV_ENDPOINT_HOSTED_ZONE_ID*stringstatic#

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

ELBV2_ACCOUNTstringelbv2_accountstrELBV2_ACCOUNTStringELBV2_ACCOUNTstringELBV2_ACCOUNT*stringstatic#

The account for ELBv2 in this region.

FIREHOSE_CIDR_BLOCKstringfirehose_cidr_blockstrFIREHOSE_CIDR_BLOCKStringFIREHOSE_CIDR_BLOCKstringFIREHOSE_CIDR_BLOCK*stringstatic#

The CIDR block used by Amazon Data Firehose servers.

IS_OPT_IN_REGIONstringis_opt_in_regionstrIS_OPT_IN_REGIONStringIS_OPT_IN_REGIONstringIS_OPT_IN_REGION*stringstatic#

Whether the given region is an opt-in region or not.

The value is a boolean modelled as YES or NO.

LATEST_NODE_RUNTIMEstringlatest_node_runtimestrLATEST_NODE_RUNTIMEStringLATEST_NODE_RUNTIMEstringLATEST_NODE_RUNTIME*stringstatic#

The latest Lambda NodeJS runtime available in a given region.

PARTITIONstringpartitionstrPARTITIONStringPARTITIONstringPARTITION*stringstatic#

The name of the partition for a region (e.g: 'aws', 'aws-cn', ...).

S3_STATIC_WEBSITE_ENDPOINTstrings3_static_website_endpointstrS3_STATIC_WEBSITE_ENDPOINTStringS3_STATIC_WEBSITE_ENDPOINTstringS3_STATIC_WEBSITE_ENDPOINT*stringstatic#

The endpoint used for hosting S3 static websites.

S3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_IDstrings3_static_website_zone_53_hosted_zone_idstrS3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_IDStringS3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_IDstringS3_STATIC_WEBSITE_ZONE_53_HOSTED_ZONE_ID*stringstatic#

The endpoint used for aliasing S3 static websites in Route 53.

SAML_SIGN_ON_URLstringsaml_sign_on_urlstrSAML_SIGN_ON_URLStringSAML_SIGN_ON_URLstringSAML_SIGN_ON_URL*stringstatic#

The SAML Sign On URL for partition used by IAM SAML Principal.

VPC_ENDPOINT_SERVICE_NAME_PREFIXstringvpc_endpoint_service_name_prefixstrVPC_ENDPOINT_SERVICE_NAME_PREFIXStringVPC_ENDPOINT_SERVICE_NAME_PREFIXstringVPC_ENDPOINT_SERVICE_NAME_PREFIX*stringstatic#

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

Methods

adotLambdaLayer(type: string, version: string, architecture: string): string@staticmethod def adot_lambda_layer(type: str, version: str, architecture: str) -> strpublic static String adotLambdaLayer(String type, String version, String architecture)public static string AdotLambdaLayer(string type, string version, string architecture)func AdotLambdaLayer(Type *string, Version *string, Architecture *string) *stringstatic#

The ARN of Amazon Distro for OpenTelemetry (ADOT) Lambda layer for a given lambda type, version and architecture.

3 parameters

Parameters

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

appConfigLambdaLayerVersion(version: string, arch?: string): string@staticmethod def app_config_lambda_layer_version(version: str, arch: typing.Optional[str] = None) -> strpublic static String appConfigLambdaLayerVersion(String version, String arch)public static string AppConfigLambdaLayerVersion(string version, string? arch = null)func AppConfigLambdaLayerVersion(Version *string, Arch *string) *stringstatic#

The ARN of AppConfig Lambda Layer for a given version (e.g. 2.0.181).

2 parameters

Parameters

• versionversionversionversionVersion — The layer version.
• archarcharcharchArch — The architecture (optional), defaults to x86_64.

cloudwatchLambdaInsightsVersion(version: string, arch?: string): string@staticmethod def cloudwatch_lambda_insights_version(version: str, arch: typing.Optional[str] = None) -> strpublic static String cloudwatchLambdaInsightsVersion(String version, String arch)public static string CloudwatchLambdaInsightsVersion(string version, string? arch = null)func CloudwatchLambdaInsightsVersion(Version *string, Arch *string) *stringstatic#

The ARN of CloudWatch Lambda Insights for a version (e.g. 1.0.98.0).

paramsAndSecretsLambdaLayer(version: string, architecture: string): string@staticmethod def params_and_secrets_lambda_layer(version: str, architecture: str) -> strpublic static String paramsAndSecretsLambdaLayer(String version, String architecture)public static string ParamsAndSecretsLambdaLayer(string version, string architecture)func ParamsAndSecretsLambdaLayer(Version *string, Architecture *string) *stringstatic#

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

2 parameters

Parameters

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

servicePrincipal(service: string): string@staticmethod def service_principal(service: str) -> strpublic static String servicePrincipal(String service)public static string ServicePrincipal(string service)func ServicePrincipal(Service *string) *stringstaticdeprecated#

- Use `iam.ServicePrincipal.servicePrincipalName()` instead.

1 parameter

Parameters

• serviceserviceserviceserviceService — the service name, either simple (e.g: s3, codedeploy) or qualified (e.g: s3.amazonaws.com). The .amazonaws.com and .amazonaws.com.rproxy.goskope.com.cn domains are stripped from service names, so they are canonicalized in that respect.