KeyArgs

data class KeyArgs(val annotations: Output<Map<String, String>>? = null, val displayName: Output<String>? = null, val keyId: Output<String>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val restrictions: Output<V2RestrictionsArgs>? = null) : ConvertibleToJava<KeyArgs>

Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is global. Auto-naming is currently not supported for this resource.

Constructors

Link copied to clipboard
fun KeyArgs(annotations: Output<Map<String, String>>? = null, displayName: Output<String>? = null, keyId: Output<String>? = null, location: Output<String>? = null, project: Output<String>? = null, restrictions: Output<V2RestrictionsArgs>? = null)

Functions

Link copied to clipboard
open override fun toJava(): KeyArgs

Properties

Link copied to clipboard
val annotations: Output<Map<String, String>>? = null

Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Link copied to clipboard
val displayName: Output<String>? = null

Human-readable display name of this key that you can modify. The maximum length is 63 characters.

Link copied to clipboard
val keyId: Output<String>? = null

User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val restrictions: Output<V2RestrictionsArgs>? = null

Key restrictions.