TagKeyArgs

data class TagKeyArgs(val description: Output<String>? = null, val etag: Output<String>? = null, val name: Output<String>? = null, val parent: Output<String>? = null, val purpose: Output<TagKeyPurpose>? = null, val purposeData: Output<Map<String, String>>? = null, val shortName: Output<String>? = null) : ConvertibleToJava<TagKeyArgs>

Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.

Constructors

Link copied to clipboard
fun TagKeyArgs(description: Output<String>? = null, etag: Output<String>? = null, name: Output<String>? = null, parent: Output<String>? = null, purpose: Output<TagKeyPurpose>? = null, purposeData: Output<Map<String, String>>? = null, shortName: Output<String>? = null)

Functions

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

Properties

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

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

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

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.

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

Immutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for the TagKey.

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

Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form organizations/{org_id}. For a TagKey parented by a Project, its parent can be in the form projects/{project_id} or projects/{project_number}.

Link copied to clipboard
val purpose: Output<TagKeyPurpose>? = null

Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.

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

Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for Purpose for formatting of this field. Purpose data cannot be changed once set.

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

Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character (a-z0-9A-Z) with dashes (-), underscores (_), dots (.), and alphanumerics between.