Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsSshKey
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsSshKey

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create, update, or delete an SSH key. The SSH key is used to access a Generation 2 virtual server instance. For more information, about SSH key, see managing SSH Keys.

Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

provider.tf

import * as pulumi from "@pulumi/pulumi";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}
Copy
{}
Copy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = new ibm.IsSshKey("example", {
    publicKey: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR",
    type: "rsa",
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.IsSshKey("example",
    public_key="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR",
    type="rsa")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsSshKey(ctx, "example", &ibm.IsSshKeyArgs{
			PublicKey: pulumi.String("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR"),
			Type:      pulumi.String("rsa"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsSshKey("example", new()
    {
        PublicKey = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR",
        Type = "rsa",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsSshKey;
import com.pulumi.ibm.IsSshKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new IsSshKey("example", IsSshKeyArgs.builder()
            .publicKey("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR")
            .type("rsa")
            .build());

    }
}
Copy
resources:
  example:
    type: ibm:IsSshKey
    properties:
      publicKey: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCKVmnMOlHKcZK8tpt3MP1lqOLAcqcJzhsvJcjscgVERRN7/9484SOBJ3HSKxxNG5JN8owAjy5f9yYwcUg+JaUVuytn5Pv3aeYROHGGg+5G346xaq3DAwX6Y5ykr2fvjObgncQBnuU5KHWCECO/4h8uWuwh/kfniXPVjFToc+gnkqA+3RKpAecZhFXwfalQ9mMuYGFxn+fwn8cYEApsJbsEmb0iJwPiZ5hjFC8wREuiTlhPHDgkBLOiycd20op2nXzDbHfCHInquEe/gYxEitALONxm0swBOwJZwlTDOB7C6y2dzlrtxr1L59m7pCkWI4EtTRLvleehBoj3u7jB4usR
      type: rsa
Copy

Create IsSshKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IsSshKey(name: string, args: IsSshKeyArgs, opts?: CustomResourceOptions);
@overload
def IsSshKey(resource_name: str,
             args: IsSshKeyArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def IsSshKey(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             public_key: Optional[str] = None,
             access_tags: Optional[Sequence[str]] = None,
             is_ssh_key_id: Optional[str] = None,
             name: Optional[str] = None,
             resource_group: Optional[str] = None,
             tags: Optional[Sequence[str]] = None,
             type: Optional[str] = None)
func NewIsSshKey(ctx *Context, name string, args IsSshKeyArgs, opts ...ResourceOption) (*IsSshKey, error)
public IsSshKey(string name, IsSshKeyArgs args, CustomResourceOptions? opts = null)
public IsSshKey(String name, IsSshKeyArgs args)
public IsSshKey(String name, IsSshKeyArgs args, CustomResourceOptions options)

type: ibm:IsSshKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IsSshKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IsSshKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IsSshKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IsSshKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IsSshKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var isSshKeyResource = new Ibm.IsSshKey("isSshKeyResource", new()
{
    PublicKey = "string",
    AccessTags = new[]
    {
        "string",
    },
    IsSshKeyId = "string",
    Name = "string",
    ResourceGroup = "string",
    Tags = new[]
    {
        "string",
    },
    Type = "string",
});
Copy
example, err := ibm.NewIsSshKey(ctx, "isSshKeyResource", &ibm.IsSshKeyArgs{
	PublicKey: pulumi.String("string"),
	AccessTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsSshKeyId:    pulumi.String("string"),
	Name:          pulumi.String("string"),
	ResourceGroup: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Type: pulumi.String("string"),
})
Copy
var isSshKeyResource = new IsSshKey("isSshKeyResource", IsSshKeyArgs.builder()
    .publicKey("string")
    .accessTags("string")
    .isSshKeyId("string")
    .name("string")
    .resourceGroup("string")
    .tags("string")
    .type("string")
    .build());
Copy
is_ssh_key_resource = ibm.IsSshKey("isSshKeyResource",
    public_key="string",
    access_tags=["string"],
    is_ssh_key_id="string",
    name="string",
    resource_group="string",
    tags=["string"],
    type="string")
Copy
const isSshKeyResource = new ibm.IsSshKey("isSshKeyResource", {
    publicKey: "string",
    accessTags: ["string"],
    isSshKeyId: "string",
    name: "string",
    resourceGroup: "string",
    tags: ["string"],
    type: "string",
});
Copy
type: ibm:IsSshKey
properties:
    accessTags:
        - string
    isSshKeyId: string
    name: string
    publicKey: string
    resourceGroup: string
    tags:
        - string
    type: string
Copy

IsSshKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IsSshKey resource accepts the following input properties:

PublicKey This property is required. string
The public SSH key.
AccessTags List<string>

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

IsSshKeyId string
(String) The ID of the SSH key.
Name string
The user-defined name for this key.
ResourceGroup string
The resource group ID where the SSH is created.
Tags List<string>
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
Type string

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

PublicKey This property is required. string
The public SSH key.
AccessTags []string

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

IsSshKeyId string
(String) The ID of the SSH key.
Name string
The user-defined name for this key.
ResourceGroup string
The resource group ID where the SSH is created.
Tags []string
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
Type string

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

publicKey This property is required. String
The public SSH key.
accessTags List<String>

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

isSshKeyId String
(String) The ID of the SSH key.
name String
The user-defined name for this key.
resourceGroup String
The resource group ID where the SSH is created.
tags List<String>
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
type String

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

publicKey This property is required. string
The public SSH key.
accessTags string[]

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

isSshKeyId string
(String) The ID of the SSH key.
name string
The user-defined name for this key.
resourceGroup string
The resource group ID where the SSH is created.
tags string[]
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
type string

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

public_key This property is required. str
The public SSH key.
access_tags Sequence[str]

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

is_ssh_key_id str
(String) The ID of the SSH key.
name str
The user-defined name for this key.
resource_group str
The resource group ID where the SSH is created.
tags Sequence[str]
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
type str

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

publicKey This property is required. String
The public SSH key.
accessTags List<String>

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

isSshKeyId String
(String) The ID of the SSH key.
name String
The user-defined name for this key.
resourceGroup String
The resource group ID where the SSH is created.
tags List<String>
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
type String

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

Outputs

All input properties are implicitly available as output properties. Additionally, the IsSshKey resource produces the following output properties:

CreatedAt string
(String) The date and time that the key was created.
Crn string
(String) The CRN for this key.
Fingerprint string
(String) The SHA256 fingerprint of the public key.
Href string
(String) The URL for this key.
Id string
The provider-assigned unique ID for this managed resource.
Length double
(String) The length of this key.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
CreatedAt string
(String) The date and time that the key was created.
Crn string
(String) The CRN for this key.
Fingerprint string
(String) The SHA256 fingerprint of the public key.
Href string
(String) The URL for this key.
Id string
The provider-assigned unique ID for this managed resource.
Length float64
(String) The length of this key.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
createdAt String
(String) The date and time that the key was created.
crn String
(String) The CRN for this key.
fingerprint String
(String) The SHA256 fingerprint of the public key.
href String
(String) The URL for this key.
id String
The provider-assigned unique ID for this managed resource.
length Double
(String) The length of this key.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
createdAt string
(String) The date and time that the key was created.
crn string
(String) The CRN for this key.
fingerprint string
(String) The SHA256 fingerprint of the public key.
href string
(String) The URL for this key.
id string
The provider-assigned unique ID for this managed resource.
length number
(String) The length of this key.
resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn string
The crn of the resource
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
created_at str
(String) The date and time that the key was created.
crn str
(String) The CRN for this key.
fingerprint str
(String) The SHA256 fingerprint of the public key.
href str
(String) The URL for this key.
id str
The provider-assigned unique ID for this managed resource.
length float
(String) The length of this key.
resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resource_crn str
The crn of the resource
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
createdAt String
(String) The date and time that the key was created.
crn String
(String) The CRN for this key.
fingerprint String
(String) The SHA256 fingerprint of the public key.
href String
(String) The URL for this key.
id String
The provider-assigned unique ID for this managed resource.
length Number
(String) The length of this key.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource

Look up Existing IsSshKey Resource

Get an existing IsSshKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IsSshKeyState, opts?: CustomResourceOptions): IsSshKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        fingerprint: Optional[str] = None,
        href: Optional[str] = None,
        is_ssh_key_id: Optional[str] = None,
        length: Optional[float] = None,
        name: Optional[str] = None,
        public_key: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        type: Optional[str] = None) -> IsSshKey
func GetIsSshKey(ctx *Context, name string, id IDInput, state *IsSshKeyState, opts ...ResourceOption) (*IsSshKey, error)
public static IsSshKey Get(string name, Input<string> id, IsSshKeyState? state, CustomResourceOptions? opts = null)
public static IsSshKey get(String name, Output<String> id, IsSshKeyState state, CustomResourceOptions options)
resources:  _:    type: ibm:IsSshKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccessTags List<string>

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

CreatedAt string
(String) The date and time that the key was created.
Crn string
(String) The CRN for this key.
Fingerprint string
(String) The SHA256 fingerprint of the public key.
Href string
(String) The URL for this key.
IsSshKeyId string
(String) The ID of the SSH key.
Length double
(String) The length of this key.
Name string
The user-defined name for this key.
PublicKey string
The public SSH key.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroup string
The resource group ID where the SSH is created.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
Tags List<string>
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
Type string

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

AccessTags []string

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

CreatedAt string
(String) The date and time that the key was created.
Crn string
(String) The CRN for this key.
Fingerprint string
(String) The SHA256 fingerprint of the public key.
Href string
(String) The URL for this key.
IsSshKeyId string
(String) The ID of the SSH key.
Length float64
(String) The length of this key.
Name string
The user-defined name for this key.
PublicKey string
The public SSH key.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroup string
The resource group ID where the SSH is created.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
Tags []string
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
Type string

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

accessTags List<String>

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

createdAt String
(String) The date and time that the key was created.
crn String
(String) The CRN for this key.
fingerprint String
(String) The SHA256 fingerprint of the public key.
href String
(String) The URL for this key.
isSshKeyId String
(String) The ID of the SSH key.
length Double
(String) The length of this key.
name String
The user-defined name for this key.
publicKey String
The public SSH key.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroup String
The resource group ID where the SSH is created.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
tags List<String>
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
type String

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

accessTags string[]

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

createdAt string
(String) The date and time that the key was created.
crn string
(String) The CRN for this key.
fingerprint string
(String) The SHA256 fingerprint of the public key.
href string
(String) The URL for this key.
isSshKeyId string
(String) The ID of the SSH key.
length number
(String) The length of this key.
name string
The user-defined name for this key.
publicKey string
The public SSH key.
resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn string
The crn of the resource
resourceGroup string
The resource group ID where the SSH is created.
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
tags string[]
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
type string

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

access_tags Sequence[str]

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

created_at str
(String) The date and time that the key was created.
crn str
(String) The CRN for this key.
fingerprint str
(String) The SHA256 fingerprint of the public key.
href str
(String) The URL for this key.
is_ssh_key_id str
(String) The ID of the SSH key.
length float
(String) The length of this key.
name str
The user-defined name for this key.
public_key str
The public SSH key.
resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resource_crn str
The crn of the resource
resource_group str
The resource group ID where the SSH is created.
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
tags Sequence[str]
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
type str

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

accessTags List<String>

A list of access management tags to attach to the ssh key.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

createdAt String
(String) The date and time that the key was created.
crn String
(String) The CRN for this key.
fingerprint String
(String) The SHA256 fingerprint of the public key.
href String
(String) The URL for this key.
isSshKeyId String
(String) The ID of the SSH key.
length Number
(String) The length of this key.
name String
The user-defined name for this key.
publicKey String
The public SSH key.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroup String
The resource group ID where the SSH is created.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
tags List<String>
A list of tags that you want to add to your SSH key. Tags can help you find the SSH key more easily later.
type String

The crypto system used by this key. Default value is 'rsa. Allowed values are : [ed25519, rsa].

Note: • ed25519 can only be used if the operating system supports this key type. • ed25519 can't be used with Windows or VMware images.

Import

The ibm_is_ssh_key resource can be imported by using the SSH key ID.

Syntax

$ pulumi import ibm:index/isSshKey:IsSshKey example <ssh_key_ID>
Copy

Example

$ pulumi import ibm:index/isSshKey:IsSshKey example d7bec597-4726-451f-8a63-e62e6f19c32c
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm