Interface CfnAPIKey.IApiKeyRestrictionsProperty

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

Namespace: Amazon.CDK.AWS.Location

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnAPIKey.IApiKeyRestrictionsProperty

Syntax (vb)

Public Interface CfnAPIKey.IApiKeyRestrictionsProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// 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
                 AllowReferers = new [] { "allowReferers" }
             };

Synopsis

Properties

AllowActions	A list of allowed actions that an API key resource grants permissions to perform.
AllowReferers	An optional list of allowed HTTP referers for which requests must originate from.
AllowResources	A list of allowed resource ARNs that a API key bearer can perform actions on.

Properties

AllowActions

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

string[] AllowActions { get; }

Property Value

string[]

Remarks

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.

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

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