HostKey class

Manages a host key for a server. This is an additional server host key.

Example Usage

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

const example = new aws.transfer.HostKey("example", {
    serverId: exampleAwsTransferServer.id,
    description: "example additional host key",
    hostKeyBodyWo: "# Private key PEM.\n",
});
import pulumi
import pulumi_aws as aws

example = aws.transfer.HostKey("example",
    server_id=example_aws_transfer_server["id"],
    description="example additional host key",
    host_key_body_wo="# Private key PEM.\n")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Transfer.HostKey("example", new()
    {
        ServerId = exampleAwsTransferServer.Id,
        Description = "example additional host key",
        HostKeyBodyWo = @"# Private key PEM.
",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/transfer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := transfer.NewHostKey(ctx, "example", &transfer.HostKeyArgs{
			ServerId:      pulumi.Any(exampleAwsTransferServer.Id),
			Description:   pulumi.String("example additional host key"),
			HostKeyBodyWo: pulumi.String("# Private key PEM.\n"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_transfer_hostkey" "example" {
  server_id        = exampleAwsTransferServer.id
  description      = "example additional host key"
  host_key_body_wo = "# Private key PEM.\n"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.transfer.HostKey;
import com.pulumi.aws.transfer.HostKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 HostKey("example", HostKeyArgs.builder()
            .serverId(exampleAwsTransferServer.id())
            .description("example additional host key")
            .hostKeyBodyWo("""
# Private key PEM.
            """)
            .build());

    }
}
resources:
  example:
    type: aws:transfer:HostKey
    properties:
      serverId: ${exampleAwsTransferServer.id}
      description: example additional host key
      hostKeyBodyWo: |
        # Private key PEM.

Import

Using pulumi import, import host keys using the serverId and hostKeyId separated by ,. For example:

$ pulumi import aws:transfer/hostKey:HostKey example s-12345678,key-12345

Constructors

HostKey(String name, {HostKeyArgs? args, CustomResourceOptions? options})
Creates a new HostKey. name The Pulumi resource name. args Arguments used to configure this HostKey. The set of arguments for HostKey. options Resource options controlling this resource's behavior.
HostKey.reference(String urn)
Creates a typed reference to an existing HostKey resource.

Properties

arn ↔ Output<String>
ARN of host key.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
Text description.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
hostKeyBody ↔ Output<String?>
Private key portion of an SSH key pair.
latefinal
hostKeyBodyWo ↔ Output<String?>
NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only private key portion of an SSH key pair, guaranteed not to be written to plan or state artifacts. One of hostKeyBody or hostKeyBodyWo must be configured.
latefinal
hostKeyFingerprint ↔ Output<String>
Public key fingerprint.
latefinal
hostKeyId ↔ Output<String>
ID of the host key.
latefinal
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverId ↔ Output<String>
Server ID.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {HostKeyState? state, CustomResourceOptions? options}) → HostKey
Gets an existing HostKey resource's state with the given name and id.