Package com.pulumi.aws.transfer

Class HostKey

  • public class HostKey
extends com.pulumi.resources.CustomResource
    Manages a host key for a server. This is an [_additional server host key_](https://docs.aws.amazon.com/transfer/latest/userguide/server-host-key-add.html). ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import host keys using the `serverId` and `hostKeyId` separated by `,`. For example: ```sh $ pulumi import aws:transfer/hostKey:HostKey example s-12345678,key-12345 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      HostKey​(java.lang.String name)  
      HostKey​(java.lang.String name, HostKeyArgs args)  
      HostKey​(java.lang.String name, HostKeyArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static HostKey get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, HostKeyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> hostKeyBody()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> hostKeyBodyWo()  
      com.pulumi.core.Output<java.lang.String> hostKeyFingerprint()  
      com.pulumi.core.Output<java.lang.String> hostKeyId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> serverId()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • HostKey

        public HostKey​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • HostKey

        public HostKey​(java.lang.String name,
               HostKeyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • HostKey

        public HostKey​(java.lang.String name,
               HostKeyArgs args,
               @Nullable
               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of host key.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Text description.

      • hostKeyBody

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> hostKeyBody()
        Returns:
        Private key portion of an SSH key pair.

      • hostKeyBodyWo

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> hostKeyBodyWo()
        Returns:
        **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.

      • hostKeyFingerprint

        public com.pulumi.core.Output<java.lang.String> hostKeyFingerprint()
        Returns:
        Public key fingerprint.

      • hostKeyId

        public com.pulumi.core.Output<java.lang.String> hostKeyId()
        Returns:
        ID of the host key.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • serverId

        public com.pulumi.core.Output<java.lang.String> serverId()
        Returns:
        Server ID.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static HostKey get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          HostKeyState state,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.