Experimental
@aws-cdk/aws-location-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ApiKey L2 construct
An API Key.
Example
new location.ApiKey(this, 'APIKeyAny', {
// specify allowed actions
allowMapsActions: [
location.AllowMapsAction.GET_STATIC_MAP,
],
allowPlacesActions: [
location.AllowPlacesAction.GET_PLACE,
],
allowRoutesActions: [
location.AllowRoutesAction.CALCULATE_ISOLINES,
],
});
location.ApiKey(self, "APIKeyAny",
# specify allowed actions
allow_maps_actions=[location.AllowMapsAction.GET_STATIC_MAP
],
allow_places_actions=[location.AllowPlacesAction.GET_PLACE
],
allow_routes_actions=[location.AllowRoutesAction.CALCULATE_ISOLINES
]
)
ApiKey.Builder.create(this, "APIKeyAny")
// specify allowed actions
.allowMapsActions(List.of(AllowMapsAction.GET_STATIC_MAP))
.allowPlacesActions(List.of(AllowPlacesAction.GET_PLACE))
.allowRoutesActions(List.of(AllowRoutesAction.CALCULATE_ISOLINES))
.build();
// Install: dotnet add package Amazon.CDK.AWS.Location.Alpha
new ApiKey(this, "APIKeyAny", new ApiKeyProps {
// specify allowed actions
AllowMapsActions = new [] { AllowMapsAction.GET_STATIC_MAP },
AllowPlacesActions = new [] { AllowPlacesAction.GET_PLACE },
AllowRoutesActions = new [] { AllowRoutesAction.CALCULATE_ISOLINES }
});
// Install: go get github.com/aws/aws-cdk-go/awscdklocationalpha/v2
location.NewApiKey(this, jsii.String("APIKeyAny"), &ApiKeyProps{
// specify allowed actions
AllowMapsActions: []AllowMapsAction{
location.AllowMapsAction_GET_STATIC_MAP,
},
AllowPlacesActions: []AllowPlacesAction{
location.AllowPlacesAction_GET_PLACE,
},
AllowRoutesActions: []AllowRoutesAction{
location.AllowRoutesAction_CALCULATE_ISOLINES,
},
})
Initializer
new ApiKey(scope: Construct, id: string, props?: ApiKeyProps)
ApiKey(scope: Construct, id: str, props: typing.Optional[ApiKeyProps] = None)
new ApiKey(Construct scope, String id, ApiKeyProps props)
new ApiKey(Construct scope, string id, ApiKeyProps? props = null)
NewApiKey(Scope Construct, Id *string, Props ApiKeyProps)
Construct Props
allowMapsActionsAllowMapsAction[]allow_maps_actionstyping.List[AllowMapsAction]allowMapsActionsList<AllowMapsAction>AllowMapsActionsAllowMapsAction[]AllowMapsActions*[]AllowMapsAction#Default: no actions for Maps are permitted
allowPlacesActionsAllowPlacesAction[]allow_places_actionstyping.List[AllowPlacesAction]allowPlacesActionsList<AllowPlacesAction>AllowPlacesActionsAllowPlacesAction[]AllowPlacesActions*[]AllowPlacesAction#Default: no actions for Places are permitted
allowReferersstring[]allow_refererstyping.List[str]allowReferersList<String>AllowReferersstring[]AllowReferers*[]*string#Default: no Referer
Requests using this API key from other domains will not be allowed.
allowRoutesActionsAllowRoutesAction[]allow_routes_actionstyping.List[AllowRoutesAction]allowRoutesActionsList<AllowRoutesAction>AllowRoutesActionsAllowRoutesAction[]AllowRoutesActions*[]AllowRoutesAction#Default: no actions for Routes are permitted
Default: A name is automatically generated
Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.
Must be a unique API key name.
Default: no description
Default: undefined - The API Key never expires
expireTime must be set when noExpiry is false or undefined. When expireTime is not set, noExpiry must be true.
Default: undefined - not force delete
Set the parameter true to delete the key or to false to not preemptively delete the API key.
Default: undefined - not force update
Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.
Default: undefined - The API Key expires at expireTime
Set to true when expireTime is not set. When you set expireTime, noExpiry must be false or undefined.
Properties
apiKeyCreateTimestringapi_key_create_timestrapiKeyCreateTimeStringApiKeyCreateTimestringApiKeyCreateTime*stringrequired#apiKeyUpdateTimestringapi_key_update_timestrapiKeyUpdateTimeStringApiKeyUpdateTimestringApiKeyUpdateTime*stringrequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromApiKeyArn(scope: Construct, id: string, apiKeyArn: string): IApiKey@staticmethod def from_api_key_arn(scope: Construct, id: str, api_key_arn: str) -> IApiKeypublic static IApiKey fromApiKeyArn(Construct scope, String id, String apiKeyArn)public static IApiKey FromApiKeyArn(Construct scope, string id, string apiKeyArn)func FromApiKeyArn(Scope Construct, Id *string, ApiKeyArn *string) IApiKeystatic#fromApiKeyName(scope: Construct, id: string, apiKeyName: string): IApiKey@staticmethod def from_api_key_name(scope: Construct, id: str, api_key_name: str) -> IApiKeypublic static IApiKey fromApiKeyName(Construct scope, String id, String apiKeyName)public static IApiKey FromApiKeyName(Construct scope, string id, string apiKeyName)func FromApiKeyName(Scope Construct, Id *string, ApiKeyName *string) IApiKeystatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.