@aws-cdk_region-info.Default

class Default

LanguageType name
.NETAmazon.CDK.RegionInfo.Default
Javasoftware.amazon.awscdk.regioninfo.Default
Pythonaws_cdk.region_info.Default
TypeScript (source)@aws-cdk/region-info » Default

Provides default values for certain regional information points.

Properties

NameTypeDescription
static VPC_ENDPOINT_SERVICE_NAME_PREFIXstringThe default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is { "Ref": "AWS::Region" }).

static VPC_ENDPOINT_SERVICE_NAME_PREFIX

Type: string

The default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is { "Ref": "AWS::Region" }).

Methods

NameDescription
static servicePrincipal(serviceFqn, region, urlSuffix)Computes a "standard" AWS Service principal for a given service, region and suffix.

static servicePrincipal(serviceFqn, region, urlSuffix)

public static servicePrincipal(serviceFqn: string, region: string, urlSuffix: string): string

Parameters

  • serviceFqn string — the name of the service (s3, s3.amazonaws.com, ...).
  • region string — the region in which the service principal is needed.
  • urlSuffix string — deprecated and ignored.

Returns

  • string

Computes a "standard" AWS Service principal for a given service, region and suffix.

This is useful for example when you need to compute a service principal name, but you do not have a synthesize-time region literal available (so all you have is { "Ref": "AWS::Region" }). This way you get the same defaulting behavior that is normally used for built-in data.