Package software.amazon.awscdk.services.location

Class CfnAPIKey.ApiKeyRestrictionsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.location.CfnAPIKey.ApiKeyRestrictionsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnAPIKey.ApiKeyRestrictionsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAPIKey.ApiKeyRestrictionsProperty

@Stability(Stable)
@Internal
public static final class CfnAPIKey.ApiKeyRestrictionsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnAPIKey.ApiKeyRestrictionsProperty

An implementation for CfnAPIKey.ApiKeyRestrictionsProperty

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.location.CfnAPIKey.ApiKeyRestrictionsProperty

CfnAPIKey.ApiKeyRestrictionsProperty.Builder, CfnAPIKey.ApiKeyRestrictionsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAPIKey.ApiKeyRestrictionsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAPIKey.ApiKeyRestrictionsProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getAllowActions()	A list of allowed actions that an API key resource grants permissions to perform.
final List<String>	getAllowReferers()	An optional list of allowed HTTP referers for which requests must originate from.
final List<String>	getAllowResources()	A list of allowed resource ARNs that a API key bearer can perform actions on.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnAPIKey.ApiKeyRestrictionsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnAPIKey.ApiKeyRestrictionsProperty.Builder.

Method Details

getAllowActions

public final List<String> getAllowActions()

Description copied from interface: CfnAPIKey.ApiKeyRestrictionsProperty

A list of allowed actions that an API key resource grants permissions to perform.

You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.

The following are valid values for the actions.

• Map actions
• geo:GetMap* - Allows all actions needed for map rendering.
• Place actions
• geo:SearchPlaceIndexForText - Allows geocoding.
• geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
• geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
• geo:GetPlace - Allows finding a place by place ID.
• Route actions
• geo:CalculateRoute - Allows point to point routing.
• geo:CalculateRouteMatrix - Allows calculating a matrix of routes.

You must use these strings exactly. For example, to provide access to map rendering, the only valid action is geo:GetMap* as an input to the list. ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"] - you must list each of the Place actions separately.

Specified by:

getAllowActions in interface CfnAPIKey.ApiKeyRestrictionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-apikey-apikeyrestrictions.html#cfn-location-apikey-apikeyrestrictions-allowactions

getAllowResources

public final List<String> getAllowResources()

Description copied from interface: CfnAPIKey.ApiKeyRestrictionsProperty

A list of allowed resource ARNs that a API key bearer can perform actions on.

• The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
• The resources must be in the same partition , region , and account-id as the key that is being created.
• Other than wildcards, you must include the full ARN, including the arn , partition , service , region , account-id and resource-id delimited by colons (:).
• No spaces allowed, even with wildcards. For example, arn:aws:geo:region: *account-id* :map/ExampleMap* .

For more information about ARN format, see Amazon Resource Names (ARNs) .

Specified by:

getAllowResources in interface CfnAPIKey.ApiKeyRestrictionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-apikey-apikeyrestrictions.html#cfn-location-apikey-apikeyrestrictions-allowresources

getAllowReferers

public final List<String> getAllowReferers()

Description copied from interface: CfnAPIKey.ApiKeyRestrictionsProperty

An optional list of allowed HTTP referers for which requests must originate from.

Requests using this API key from other domains will not be allowed.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*(),;/?:@=&`
• May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
• May contain wildcard characters question mark (?) and asterisk (*).

Question mark (?) will replace any single character (including hexadecimal digits).

Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).

• No spaces allowed. For example, https://example.com .

Specified by:

getAllowReferers in interface CfnAPIKey.ApiKeyRestrictionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-apikey-apikeyrestrictions.html#cfn-location-apikey-apikeyrestrictions-allowreferers

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object