software.amazon.awscdk.regioninfo

Class Fact

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.regioninfo.Fact

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.17.0 (build 7d5d104)",
           date="2019-09-30T08:21:19.259Z")
 @Stability(value=Experimental)
public class Fact
extends software.amazon.jsii.JsiiObject

A database of regional information. 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	Fact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Fact(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static String	find(String region, String name) Retrieves a fact from this Fact database.
static List<String>	getRegions() EXPERIMENTAL
static void	register(IFact fact) Registers a new fact in this Fact database.
static void	register(IFact fact, Boolean allowReplacing) Registers a new fact in this Fact database.
static void	unregister(String region, String name) Removes a fact from the database.
static void	unregister(String region, String name, String value) Removes a fact from the database.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet, setObjRef

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

Fact

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

Fact

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

Method Detail

find

@Stability(value=Experimental)
public static String find(String region,
                                                         String name)

Retrieves a fact from this Fact database. EXPERIMENTAL

Parameters:

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

name - the name of the fact being looked up (see the `FactName` class for details). This parameter is required.

Returns:

the fact value if it is known, and `undefined` otherwise.

register

@Stability(value=Experimental)
public static void register(IFact fact,
                                                           Boolean allowReplacing)

Registers a new fact in this Fact database. EXPERIMENTAL

Parameters:

fact - the new fact to be registered. This parameter is required.

allowReplacing - whether new facts can replace existing facts or not.

register

@Stability(value=Experimental)
public static void register(IFact fact)

Registers a new fact in this Fact database. EXPERIMENTAL

Parameters:

fact - the new fact to be registered. This parameter is required.

unregister

@Stability(value=Experimental)
public static void unregister(String region,
                                                             String name,
                                                             String value)

Removes a fact from the database. EXPERIMENTAL

Parameters:

region - the region for which the fact is to be removed. This parameter is required.

name - the name of the fact to remove. This parameter is required.

value - the value that should be removed (removal will fail if the value is specified, but does not match the current stored value).

unregister

@Stability(value=Experimental)
public static void unregister(String region,
                                                             String name)

Removes a fact from the database. EXPERIMENTAL

Parameters:

region - the region for which the fact is to be removed. This parameter is required.

name - the name of the fact to remove. This parameter is required.

getRegions

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

EXPERIMENTAL

Returns:

the list of names of AWS regions for which there is at least one registered fact. This may not be an exhaustive list of all available AWS regions.