ApiKeyRestrictionsProperty Struct
API Restrictions on the allowed actions, resources, and referers for an API key resource.
| Source | |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_location as location } from 'aws-cdk-lib';
const apiKeyRestrictionsProperty: location.CfnAPIKey.ApiKeyRestrictionsProperty = {
allowActions: ['allowActions'],
allowResources: ['allowResources'],
// the properties below are optional
allowAndroidApps: [{
certificateFingerprint: 'certificateFingerprint',
package: 'package',
}],
allowAppleApps: [{
bundleId: 'bundleId',
}],
allowReferers: ['allowReferers'],
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_location as location
api_key_restrictions_property = location.CfnAPIKey.ApiKeyRestrictionsProperty(
allow_actions=["allowActions"],
allow_resources=["allowResources"],
# the properties below are optional
allow_android_apps=[location.CfnAPIKey.AndroidAppProperty(
certificate_fingerprint="certificateFingerprint",
package="package"
)],
allow_apple_apps=[location.CfnAPIKey.AppleAppProperty(
bundle_id="bundleId"
)],
allow_referers=["allowReferers"]
)
// 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();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Location;
var apiKeyRestrictionsProperty = new ApiKeyRestrictionsProperty {
AllowActions = new [] { "allowActions" },
AllowResources = new [] { "allowResources" },
// the properties below are optional
AllowAndroidApps = new [] { new AndroidAppProperty {
CertificateFingerprint = "certificateFingerprint",
Package = "package"
} },
AllowAppleApps = new [] { new AppleAppProperty {
BundleId = "bundleId"
} },
AllowReferers = new [] { "allowReferers" }
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
apiKeyRestrictionsProperty := &ApiKeyRestrictionsProperty{
AllowActions: []*string{
jsii.String("allowActions"),
},
AllowResources: []*string{
jsii.String("allowResources"),
},
// the properties below are optional
AllowAndroidApps: []interface{}{
&AndroidAppProperty{
CertificateFingerprint: jsii.String("certificateFingerprint"),
Package: jsii.String("package"),
},
},
AllowAppleApps: []interface{}{
&AppleAppProperty{
BundleId: jsii.String("bundleId"),
},
},
AllowReferers: []*string{
jsii.String("allowReferers"),
},
}
Properties
allowActionsstring[]allow_actionstyping.List[str]allowActionsList<String>AllowActionsstring[]AllowActions*[]*string required #notes
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.
allowAndroidAppsoptionalIResolvable | IResolvable | CfnAPIKey.AndroidAppProperty[]allow_android_appsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AndroidAppProperty]]]allowAndroidAppsoptionalIResolvableAllowAndroidAppsoptionalIResolvableAllowAndroidAppsoptionalinterface{} #allowAppleAppsoptionalIResolvable | IResolvable | CfnAPIKey.AppleAppProperty[]allow_apple_appsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AppleAppProperty]]]allowAppleAppsoptionalIResolvableAllowAppleAppsoptionalIResolvableAllowAppleAppsoptionalinterface{} #allowReferersoptionalstring[]allow_referersoptionaltyping.List[str]allowReferersoptionalList<String>AllowReferersoptionalstring[]AllowReferersoptional*[]*string #notes
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.
allowResourcesstring[]allow_resourcestyping.List[str]allowResourcesList<String>AllowResourcesstring[]AllowResources*[]*string required #notes
- 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, andaccount-idas the key that is being created. - Other than wildcards, you must include the full ARN, including the
arn,partition,service,region,account-idandresource-iddelimited 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) .