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.7.0 (build 179a3a5)",
           date="2020-07-02T17:20:28.053Z")
 @Stability(value=Experimental)
public class RegionInfo
extends software.amazon.jsii.JsiiObject

Information pertaining to an AWS region.

EXPERIMENTAL

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static RegionInfo	get(String name) Obtain region info for a given region name.
Boolean	getCdkMetadataResourceAvailable() Whether the `AWS::CDK::Metadata` CloudFormation Resource is available in this region or not.
String	getDomainSuffix() The domain name suffix (e.g: amazonaws.com) for this region.
String	getName() EXPERIMENTAL
String	getPartition() The name of the ARN partition for this region (e.g: aws).
static List<RegionInfo>	getRegions() EXPERIMENTAL
String	getS3StaticWebsiteEndpoint() The endpoint used by S3 static website hosting in this region (e.g: s3-static-website-us-east-1.amazonaws.com).
String	getS3StaticWebsiteHostedZoneId() The hosted zone ID used by Route 53 to alias a S3 static website in this region (e.g: Z2O1EMRO9K5GLX).
String	getVpcEndpointServiceNamePrefix() The prefix for VPC Endpoint Service names, cn.com.amazonaws.vpce for China regions, com.amazonaws.vpce otherwise.
String	servicePrincipal(String service) The name of the service principal for a given service in this region.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, 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

Constructor Detail

RegionInfo

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

RegionInfo

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

Method Detail

get

@Stability(value=Experimental)
 @NotNull
public static RegionInfo get(@NotNull
                                                                      String name)

Obtain region info for a given region name.

EXPERIMENTAL

Parameters:

name - the name of the region (e.g: us-east-1). This parameter is required.

servicePrincipal

@Stability(value=Experimental)
 @Nullable
public String servicePrincipal(@NotNull
                                                                         String service)

The name of the service principal for a given service in this region.

EXPERIMENTAL

Parameters:

service - the service name (e.g: s3.amazonaws.com). This parameter is required.

getRegions

@Stability(value=Experimental)
 @NotNull
public static List<RegionInfo> getRegions()

EXPERIMENTAL

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(value=Experimental)
 @NotNull
public Boolean getCdkMetadataResourceAvailable()

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

EXPERIMENTAL

getName

@Stability(value=Experimental)
 @NotNull
public String getName()

EXPERIMENTAL

getDomainSuffix

@Stability(value=Experimental)
 @Nullable
public String getDomainSuffix()

The domain name suffix (e.g: amazonaws.com) for this region.

EXPERIMENTAL

getPartition

@Stability(value=Experimental)
 @Nullable
public String getPartition()

The name of the ARN partition for this region (e.g: aws).

EXPERIMENTAL

getS3StaticWebsiteEndpoint

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

EXPERIMENTAL

getS3StaticWebsiteHostedZoneId

@Stability(value=Experimental)
 @Nullable
public String getS3StaticWebsiteHostedZoneId()

The hosted zone ID used by Route 53 to alias a S3 static website in this region (e.g: Z2O1EMRO9K5GLX).

EXPERIMENTAL

getVpcEndpointServiceNamePrefix

@Stability(value=Experimental)
 @Nullable
public String getVpcEndpointServiceNamePrefix()

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

EXPERIMENTAL