Api
data class ApiKeyArgs(val description: Output<String>? = null, val expireTime: Output<String>? = null, val forceDelete: Output<Boolean>? = null, val forceUpdate: Output<Boolean>? = null, val keyName: Output<String>? = null, val noExpiry: Output<Boolean>? = null, val restrictions: Output<ApiKeyRestrictionsArgs>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<ApiKeyArgs>
Definition of AWS::Location::APIKey Resource Type
Constructors
Link copied to clipboard
constructor(description: Output<String>? = null, expireTime: Output<String>? = null, forceDelete: Output<Boolean>? = null, forceUpdate: Output<Boolean>? = null, keyName: Output<String>? = null, noExpiry: Output<Boolean>? = null, restrictions: Output<ApiKeyRestrictionsArgs>? = null, tags: Output<List<TagArgs>>? = null)
Properties
Link copied to clipboard
Updates the description for the API key resource.
Link copied to clipboard
The optional timestamp for when the API key resource will expire in ISO 8601 format .
Link copied to clipboard
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 .
Link copied to clipboard
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.
Link copied to clipboard
The API key restrictions for the API key resource.