software.amazon.awscdk.regioninfo

Class Default

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.regioninfo.Default

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-05-25T18:22:50.699Z")
 @Stability(value=Stable)
public class Default
extends software.amazon.jsii.JsiiObject

Provides default values for certain regional information points.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	VPC_ENDPOINT_SERVICE_NAME_PREFIX 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" }`).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static String	servicePrincipal(String service, String region, String urlSuffix) Computes a "standard" AWS Service principal for a given service, region and suffix.

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

Field Detail

VPC_ENDPOINT_SERVICE_NAME_PREFIX

@Stability(value=Stable)
public static final String VPC_ENDPOINT_SERVICE_NAME_PREFIX

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" }`).

Constructor Detail

Default

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

Default

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

Method Detail

servicePrincipal

@Stability(value=Stable)
 @NotNull
public static String servicePrincipal(@NotNull
                                                                         String service,
                                                                         @NotNull
                                                                         String region,
                                                                         @NotNull
                                                                         String urlSuffix)

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.

Parameters:

service - the name of the service (s3, s3.amazonaws.com, ...). This parameter is required.

region - the region in which the service principal is needed. This parameter is required.

urlSuffix - the URL suffix for the partition in which the region is located. This parameter is required.