|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "stackit_kms_wrapping_key Resource - stackit" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + KMS wrapping key resource schema. |
| 7 | +--- |
| 8 | + |
| 9 | +# stackit_kms_wrapping_key (Resource) |
| 10 | + |
| 11 | +KMS wrapping key resource schema. |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```terraform |
| 16 | +resource "stackit_kms_wrapping_key" "example" { |
| 17 | + project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" |
| 18 | + keyring_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" |
| 19 | + display_name = "example-name" |
| 20 | + protection = "software" |
| 21 | + algorithm = "rsa_2048_oaep_sha256" |
| 22 | + purpose = "wrap_symmetric_key" |
| 23 | +} |
| 24 | +``` |
| 25 | + |
| 26 | +<!-- schema generated by tfplugindocs --> |
| 27 | +## Schema |
| 28 | + |
| 29 | +### Required |
| 30 | + |
| 31 | +- `algorithm` (String) The wrapping algorithm used to wrap the key to import. Possible values are: `rsa_2048_oaep_sha256`, `rsa_3072_oaep_sha256`, `rsa_4096_oaep_sha256`, `rsa_4096_oaep_sha512`, `rsa_2048_oaep_sha256_aes_256_key_wrap`, `rsa_3072_oaep_sha256_aes_256_key_wrap`, `rsa_4096_oaep_sha256_aes_256_key_wrap`, `rsa_4096_oaep_sha512_aes_256_key_wrap`. |
| 32 | +- `display_name` (String) The display name to distinguish multiple wrapping keys. |
| 33 | +- `keyring_id` (String) The ID of the associated keyring |
| 34 | +- `project_id` (String) STACKIT project ID to which the keyring is associated. |
| 35 | +- `protection` (String) The underlying system that is responsible for protecting the key material. Possible values are: `software`. |
| 36 | +- `purpose` (String) The purpose for which the key will be used. Possible values are: `wrap_symmetric_key`, `wrap_asymmetric_key`. |
| 37 | + |
| 38 | +### Optional |
| 39 | + |
| 40 | +- `access_scope` (String) The access scope of the key. Default is `PUBLIC`. Possible values are: `PUBLIC`, `SNA`. |
| 41 | +- `description` (String) A user chosen description to distinguish multiple wrapping keys. |
| 42 | +- `region` (String) The resource region. If not defined, the provider region is used. |
| 43 | + |
| 44 | +### Read-Only |
| 45 | + |
| 46 | +- `created_at` (String) The date and time the creation of the wrapping key was triggered. |
| 47 | +- `expires_at` (String) The date and time the wrapping key will expire. |
| 48 | +- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`keyring_id`,`wrapping_key_id`". |
| 49 | +- `public_key` (String) The public key of the wrapping key. |
| 50 | +- `wrapping_key_id` (String) The ID of the wrapping key |
0 commit comments