Package software.amazon.awscdk.services.location

Interface CfnAPIKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAPIKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:13.247Z")
@Stability(Stable)
public interface CfnAPIKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAPIKey.

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.*;
 CfnAPIKeyProps cfnAPIKeyProps = CfnAPIKeyProps.builder()
         .keyName("keyName")
         .restrictions(ApiKeyRestrictionsProperty.builder()
                 .allowActions(List.of("allowActions"))
                 .allowResources(List.of("allowResources"))
                 // the properties below are optional
                 .allowReferers(List.of("allowReferers"))
                 .build())
         // the properties below are optional
         .description("description")
         .expireTime("expireTime")
         .forceDelete(false)
         .forceUpdate(false)
         .noExpiry(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAPIKeyProps.Builder	builder()
default String	getDescription()	Updates the description for the API key resource.
default String	getExpireTime()	The optional timestamp for when the API key resource will expire in ISO 8601 format .
default Object	getForceDelete()	ForceDelete bypasses an API key's expiry conditions and deletes the key.
default Object	getForceUpdate()	The boolean flag to be included for updating ExpireTime or Restrictions details.
String	getKeyName()	A custom name for the API key resource.
default Object	getNoExpiry()	Whether the API key should expire.
Object	getRestrictions()	The API key restrictions for the API key resource.
default List<CfnTag>	getTags()	Applies one or more tags to the map resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKeyName

@Stability(Stable)
@NotNull
String getKeyName()

A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
• Must be a unique API key name.
• No spaces allowed. For example, ExampleAPIKey .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-keyname

getRestrictions

@Stability(Stable)
@NotNull
Object getRestrictions()

The API key restrictions for the API key resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-restrictions

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Updates the description for the API key resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-description

getExpireTime

@Stability(Stable)
@Nullable
default String getExpireTime()

The optional timestamp for when the API key resource will expire in ISO 8601 format .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-expiretime

getForceDelete

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

ForceDelete bypasses an API key's expiry conditions and deletes the key.

Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true , or false .

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-forcedelete

getForceUpdate

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

The boolean flag to be included for updating ExpireTime or Restrictions details.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-forceupdate

getNoExpiry

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

Whether the API key should expire.

Set to true to set the API key to have no expiration time.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-noexpiry

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Applies one or more tags to the map resource.

A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-tags

builder

@Stability(Stable)
static CfnAPIKeyProps.Builder builder()

Returns:

a CfnAPIKeyProps.Builder of CfnAPIKeyProps