dependabot[bot]andJohan Brandhorst-Satzkorn
85f9a3d081
* build(deps): bump the go group across 1 directory with 2 updates Bumps the go group with 2 updates in the / directory: [github.com/hashicorp/boundary/sdk](https://github.com/hashicorp/boundary) and [github.com/hashicorp/terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs). Updates `github.com/hashicorp/boundary/sdk` from 0.0.52 to 0.0.53 - [Release notes](https://github.com/hashicorp/boundary/releases) - [Changelog](https://github.com/hashicorp/boundary/blob/main/CHANGELOG.md) - [Commits](https://github.com/hashicorp/boundary/compare/api/v0.0.52...api/v0.0.53) Updates `github.com/hashicorp/terraform-plugin-docs` from 0.21.0 to 0.22.0 - [Release notes](https://github.com/hashicorp/terraform-plugin-docs/releases) - [Changelog](https://github.com/hashicorp/terraform-plugin-docs/blob/main/CHANGELOG.md) - [Commits](https://github.com/hashicorp/terraform-plugin-docs/compare/v0.21.0...v0.22.0) --- updated-dependencies: - dependency-name: github.com/hashicorp/boundary/sdk dependency-version: 0.0.53 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: go - dependency-name: github.com/hashicorp/terraform-plugin-docs dependency-version: 0.22.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: go ... Signed-off-by: dependabot[bot] <support@github.com> * Regenerate docs --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
77 lines
2.7 KiB
Markdown
77 lines
2.7 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "boundary_credential_ssh_private_key Resource - terraform-provider-boundary"
|
|
subcategory: ""
|
|
description: |-
|
|
The SSH private key credential resource allows you to configure a credential using a username, private key and optional passphrase.
|
|
---
|
|
|
|
# boundary_credential_ssh_private_key (Resource)
|
|
|
|
The SSH private key credential resource allows you to configure a credential using a username, private key and optional passphrase.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "boundary_scope" "org" {
|
|
name = "organization_one"
|
|
description = "global scope"
|
|
scope_id = "global"
|
|
auto_create_admin_role = true
|
|
auto_create_default_role = true
|
|
}
|
|
|
|
resource "boundary_scope" "project" {
|
|
name = "project_one"
|
|
description = "My first scope!"
|
|
scope_id = boundary_scope.org.id
|
|
auto_create_admin_role = true
|
|
}
|
|
|
|
resource "boundary_credential_store_static" "example" {
|
|
name = "example_static_credential_store"
|
|
description = "My first static credential store!"
|
|
scope_id = boundary_scope.project.id
|
|
}
|
|
|
|
resource "boundary_credential_ssh_private_key" "example" {
|
|
name = "example_ssh_private_key"
|
|
description = "My first ssh private key credential!"
|
|
credential_store_id = boundary_credential_store_static.example.id
|
|
username = "my-username"
|
|
private_key = file("~/.ssh/id_rsa") # change to valid SSH Private Key
|
|
private_key_passphrase = "optional-passphrase" # change to the passphrase of the Private Key if required
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `credential_store_id` (String) ID of the credential store this credential belongs to.
|
|
- `private_key` (String, Sensitive) The private key associated with the credential.
|
|
- `username` (String) The username associated with the credential.
|
|
|
|
### Optional
|
|
|
|
- `description` (String) The description of the credential.
|
|
- `name` (String) The name of the credential. Defaults to the resource name.
|
|
- `private_key_passphrase` (String, Sensitive) The passphrase of the private key associated with the credential.
|
|
|
|
### Read-Only
|
|
|
|
- `id` (String) The ID of the credential.
|
|
- `private_key_hmac` (String) The private key hmac.
|
|
- `private_key_passphrase_hmac` (String) The private key passphrase hmac.
|
|
|
|
## Import
|
|
|
|
Import is supported using the following syntax:
|
|
|
|
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
|
|
|
|
```shell
|
|
terraform import boundary_credential_ssh_private_key.example_ssh_private_key <my-id>
|
|
```
|