Package com.pulumi.aws.redshift

Class HsmConfiguration

  • public class HsmConfiguration
extends com.pulumi.resources.CustomResource
    Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.redshift.HsmConfiguration;
 import com.pulumi.aws.redshift.HsmConfigurationArgs;
 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 HsmConfiguration("example", HsmConfigurationArgs.builder()
             .description("example")
             .hsmConfigurationIdentifier("example")
             .hsmIpAddress("10.0.0.1")
             .hsmPartitionName("aws")
             .hsmPartitionPassword("example")
             .hsmServerPublicCertificate("example")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Redshift HSM Client Certificates using `hsmConfigurationIdentifier`. For example: ```sh $ pulumi import aws:redshift/hsmConfiguration:HsmConfiguration example example ```

    • 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

    • 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.lang.String> description()  
      static HsmConfiguration get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, HsmConfigurationState 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.lang.String> hsmConfigurationIdentifier()  
      com.pulumi.core.Output<java.lang.String> hsmIpAddress()  
      com.pulumi.core.Output<java.lang.String> hsmPartitionName()  
      com.pulumi.core.Output<java.lang.String> hsmPartitionPassword()  
      com.pulumi.core.Output<java.lang.String> hsmServerPublicCertificate()  
      com.pulumi.core.Output<java.lang.String> region()  
      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

      • HsmConfiguration

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

      • HsmConfiguration

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

      • HsmConfiguration

        public HsmConfiguration​(java.lang.String name,
                        HsmConfigurationArgs 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 the HSM Client Certificate.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        A text description of the HSM configuration to be created.

      • hsmConfigurationIdentifier

        public com.pulumi.core.Output<java.lang.String> hsmConfigurationIdentifier()
        Returns:
        The identifier to be assigned to the new Amazon Redshift HSM configuration.

      • hsmIpAddress

        public com.pulumi.core.Output<java.lang.String> hsmIpAddress()
        Returns:
        The IP address that the Amazon Redshift cluster must use to access the HSM.

      • hsmPartitionName

        public com.pulumi.core.Output<java.lang.String> hsmPartitionName()
        Returns:
        The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

      • hsmPartitionPassword

        public com.pulumi.core.Output<java.lang.String> hsmPartitionPassword()
        Returns:
        The password required to access the HSM partition.

      • hsmServerPublicCertificate

        public com.pulumi.core.Output<java.lang.String> hsmServerPublicCertificate()
        Returns:
        The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

      • 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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A 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:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static HsmConfiguration get​(java.lang.String name,
                                   com.pulumi.core.Output<java.lang.String> id,
                                   @Nullable
                                   HsmConfigurationState 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.