Package software.amazon.awscdk.services.location

Interface CfnAPIKey.ApiKeyRestrictionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAPIKey.ApiKeyRestrictionsProperty.Jsii$Proxy

Enclosing class:

CfnAPIKey

@Stability(Stable)
public static interface CfnAPIKey.ApiKeyRestrictionsProperty
extends software.amazon.jsii.JsiiSerializable

API Restrictions on the allowed actions, resources, and referers for an API key resource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.location.*;
 ApiKeyRestrictionsProperty apiKeyRestrictionsProperty = ApiKeyRestrictionsProperty.builder()
         .allowActions(List.of("allowActions"))
         .allowResources(List.of("allowResources"))
         // the properties below are optional
         .allowAndroidApps(List.of(AndroidAppProperty.builder()
                 .certificateFingerprint("certificateFingerprint")
                 .package("package")
                 .build()))
         .allowAppleApps(List.of(AppleAppProperty.builder()
                 .bundleId("bundleId")
                 .build()))
         .allowReferers(List.of("allowReferers"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAPIKey.ApiKeyRestrictionsProperty.Builder	A builder for CfnAPIKey.ApiKeyRestrictionsProperty
static final class	CfnAPIKey.ApiKeyRestrictionsProperty.Jsii$Proxy	An implementation for CfnAPIKey.ApiKeyRestrictionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnAPIKey.ApiKeyRestrictionsProperty.Builder	builder()
List<String>	getAllowActions()	A list of allowed actions that an API key resource grants permissions to perform.
default Object	getAllowAndroidApps()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAPIKey.AndroidAppProperty>
default Object	getAllowAppleApps()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAPIKey.AppleAppProperty>
default List<String>	getAllowReferers()	An optional list of allowed HTTP referers for which requests must originate from.
List<String>	getAllowResources()	A list of allowed resource ARNs that a API key bearer can perform actions on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowActions

@Stability(Stable)
@NotNull
List<String> getAllowActions()

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.
• Enhanced Maps actions
• geo-maps:GetTile - Allows getting map tiles for rendering.
• geo-maps:GetStaticMap - Allows getting static map images.
• Place actions
• geo:SearchPlaceIndexForText - Allows finding geo coordinates of a known place.
• geo:SearchPlaceIndexForPosition - Allows getting nearest address to geo coordinates.
• geo:SearchPlaceIndexForSuggestions - Allows suggestions based on an incomplete or misspelled query.
• geo:GetPlace - Allows getting details of a place.
• Enhanced Places actions
• geo-places:Autcomplete - Allows auto-completion of search text.
• geo-places:Geocode - Allows finding geo coordinates of a known place.
• geo-places:GetPlace - Allows getting details of a place.
• geo-places:ReverseGeocode - Allows getting nearest address to geo coordinates.
• geo-places:SearchNearby - Allows category based places search around geo coordinates.
• geo-places:SearchText - Allows place or address search based on free-form text.
• geo-places:Suggest - Allows suggestions based on an incomplete or misspelled query.
• Route actions
• geo:CalculateRoute - Allows point to point routing.
• geo:CalculateRouteMatrix - Allows matrix routing.
• Enhanced Routes actions
• geo-routes:CalculateIsolines - Allows isoline calculation.
• geo-routes:CalculateRoutes - Allows point to point routing.
• geo-routes:CalculateRouteMatrix - Allows matrix routing.
• geo-routes:OptimizeWaypoints - Allows computing the best sequence of waypoints.
• geo-routes:SnapToRoads - Allows snapping GPS points to a likely route.

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:GetTile"] is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"] - you must list each of the Place actions separately.

See Also:

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

getAllowResources

@Stability(Stable)
@NotNull
List<String> getAllowResources()

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) .

See Also:

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

getAllowAndroidApps

@Stability(Stable)
@Nullable
default Object getAllowAndroidApps()

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAPIKey.AndroidAppProperty>

See Also:

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

getAllowAppleApps

@Stability(Stable)
@Nullable
default Object getAllowAppleApps()

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAPIKey.AppleAppProperty>

See Also:

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

getAllowReferers

@Stability(Stable)
@Nullable
default List<String> getAllowReferers()

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 .

See Also:

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

builder

@Stability(Stable)
static CfnAPIKey.ApiKeyRestrictionsProperty.Builder builder()

Returns:

a CfnAPIKey.ApiKeyRestrictionsProperty.Builder of CfnAPIKey.ApiKeyRestrictionsProperty