Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. ecs
  6. getKeypair
Viewing docs for bytepluscc v0.0.42
published on Monday, Jul 20, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.ecs.getKeypair

bytepluscc logo
Viewing docs for bytepluscc v0.0.42
published on Monday, Jul 20, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::ECS::Keypair

    Using getKeypair

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKeypair(args: GetKeypairArgs, opts?: InvokeOptions): Promise<GetKeypairResult>
function getKeypairOutput(args: GetKeypairOutputArgs, opts?: InvokeOptions): Output<GetKeypairResult>
    def get_keypair(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetKeypairResult
def get_keypair_output(id: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetKeypairResult]
    func LookupKeypair(ctx *Context, args *LookupKeypairArgs, opts ...InvokeOption) (*LookupKeypairResult, error)
func LookupKeypairOutput(ctx *Context, args *LookupKeypairOutputArgs, opts ...InvokeOption) LookupKeypairResultOutput

    > Note: This function is named LookupKeypair in the Go SDK.

    public static class GetKeypair 
{
    public static Task<GetKeypairResult> InvokeAsync(GetKeypairArgs args, InvokeOptions? opts = null)
    public static Output<GetKeypairResult> Invoke(GetKeypairInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKeypairResult> getKeypair(GetKeypairArgs args, InvokeOptions options)
public static Output<GetKeypairResult> getKeypair(GetKeypairArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:ecs/getKeypair:getKeypair
  arguments:
    # arguments dictionary
    data "bytepluscc_ecs_getkeypair" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getKeypair Result

    The following output properties are available:

    CreatedTime string
    Creation time of the key pair.
    Description string
    Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.
    FingerPrint string
    Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.
    Id string
    Uniquely identifies the resource.
    InstanceIds List<string>
    Instance ID for the operation.
    KeyPairId string
    Unique ID of the key pair.
    KeyPairName string
    Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.
    PrivateKey string
    Private key information for the key pair. Only returned when creating the key pair.
    ProjectName string
    Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.
    PublicKey string
    Public key information of the key pair.
    Tags List<Byteplus.GetKeypairTag>
    Tags of the key pair.
    UpdatedTime string
    Update time of the key pair.
    CreatedTime string
    Creation time of the key pair.
    Description string
    Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.
    FingerPrint string
    Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.
    Id string
    Uniquely identifies the resource.
    InstanceIds []string
    Instance ID for the operation.
    KeyPairId string
    Unique ID of the key pair.
    KeyPairName string
    Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.
    PrivateKey string
    Private key information for the key pair. Only returned when creating the key pair.
    ProjectName string
    Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.
    PublicKey string
    Public key information of the key pair.
    Tags []GetKeypairTag
    Tags of the key pair.
    UpdatedTime string
    Update time of the key pair.
    created_time string
    Creation time of the key pair.
    description string
    Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.
    finger_print string
    Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.
    id string
    Uniquely identifies the resource.
    instance_ids list(string)
    Instance ID for the operation.
    key_pair_id string
    Unique ID of the key pair.
    key_pair_name string
    Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.
    private_key string
    Private key information for the key pair. Only returned when creating the key pair.
    project_name string
    Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.
    public_key string
    Public key information of the key pair.
    tags list(object)
    Tags of the key pair.
    updated_time string
    Update time of the key pair.
    createdTime String
    Creation time of the key pair.
    description String
    Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.
    fingerPrint String
    Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.
    id String
    Uniquely identifies the resource.
    instanceIds List<String>
    Instance ID for the operation.
    keyPairId String
    Unique ID of the key pair.
    keyPairName String
    Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.
    privateKey String
    Private key information for the key pair. Only returned when creating the key pair.
    projectName String
    Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.
    publicKey String
    Public key information of the key pair.
    tags List<GetKeypairTag>
    Tags of the key pair.
    updatedTime String
    Update time of the key pair.
    createdTime string
    Creation time of the key pair.
    description string
    Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.
    fingerPrint string
    Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.
    id string
    Uniquely identifies the resource.
    instanceIds string[]
    Instance ID for the operation.
    keyPairId string
    Unique ID of the key pair.
    keyPairName string
    Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.
    privateKey string
    Private key information for the key pair. Only returned when creating the key pair.
    projectName string
    Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.
    publicKey string
    Public key information of the key pair.
    tags GetKeypairTag[]
    Tags of the key pair.
    updatedTime string
    Update time of the key pair.
    created_time str
    Creation time of the key pair.
    description str
    Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.
    finger_print str
    Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.
    id str
    Uniquely identifies the resource.
    instance_ids Sequence[str]
    Instance ID for the operation.
    key_pair_id str
    Unique ID of the key pair.
    key_pair_name str
    Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.
    private_key str
    Private key information for the key pair. Only returned when creating the key pair.
    project_name str
    Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.
    public_key str
    Public key information of the key pair.
    tags Sequence[GetKeypairTag]
    Tags of the key pair.
    updated_time str
    Update time of the key pair.
    createdTime String
    Creation time of the key pair.
    description String
    Description of the key pair. The default value is an empty string. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, period ('.'), space, underscore ('_'), hyphen ('-'), equals sign ('='), English comma (','), Chinese comma ('，'), and Chinese period ('。'). Length must not exceed 255 characters.
    fingerPrint String
    Fingerprint of the key pair. The public key fingerprint format is defined by RFC4716 and uses the MD5 hash algorithm.
    id String
    Uniquely identifies the resource.
    instanceIds List<String>
    Instance ID for the operation.
    keyPairId String
    Unique ID of the key pair.
    keyPairName String
    Key pair name. Must not duplicate existing names. Length must be between 2 and 64 characters. Periods ('.') can be used to separate the name into segments. Each segment can contain uppercase and lowercase letters, numbers, or hyphens ('-'). The name cannot start or end with '-' or '.', and cannot contain consecutive '-' or '.'.
    privateKey String
    Private key information for the key pair. Only returned when creating the key pair.
    projectName String
    Project to which the resource belongs. Each resource can belong to only one project. Can only contain letters, numbers, underscore ('_'), period ('.'), and hyphen ('-'). Length must not exceed 64 characters.
    publicKey String
    Public key information of the key pair.
    tags List<Property Map>
    Tags of the key pair.
    updatedTime String
    Update time of the key pair.

    Supporting Types

    GetKeypairTag

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.42
    published on Monday, Jul 20, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial